tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to bucket referer allowlist or blocklist.

Note：

COS Java SDK v5.6.52 or later is required.

Setting Bucket Referer Configuration

Description

This API (PUT Bucket referer) is used to set a referer allowlist/blocklist for a bucket.

Method prototype

public void setBucketRefererConfiguration(String bucketName, BucketRefererConfiguration configuration) throws CosClientException, CosServiceException;
public void setBucketRefererConfiguration(SetBucketRefererConfigurationRequest setBucketRefererConfigurationRequest) throws CosClientException, CosServiceException;

Sample request

// Source bucket name, including appid
String bucketName = "examplebucket-1250000000";
BucketRefererConfiguration configuration = new BucketRefererConfiguration();
// Enable hotlink protection
configuration.setStatus(BucketRefererConfiguration.DISABLED);
// Set the hotlink protection type to allowlist
//configuration.setRefererType(BucketRefererConfiguration.WHITELIST);
// Set the hotlink protection type to blocklist (either allowlist or blocklist)
configuration.setRefererType(BucketRefererConfiguration.BLACKLIST);
// Enter the domain name to be set
configuration.addDomain("test.com");
configuration.addDomain("test.1.com");
// (Optional) Set whether to allow access with an empty referer (default value: DENY)
configuration.setEmptyReferConfiguration(BucketRefererConfiguration.DENY);
// configuration.setEmptyReferConfiguration(BucketRefererConfiguration.ALLOW);
cosClient.setBucketRefererConfiguration(bucketName, configuration);

Parameter description

BucketRefererConfiguration description:

Response description

• Success: No value is returned.
• Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.

Querying Bucket Referer Configuration

Description

This API (GET Bucket referer) is used to query the referer allowlist/blocklist of a bucket.

Method prototype

public BucketRefererConfiguration getBucketRefererConfiguration(String bucketName) throws CosClientException, CosServiceException

Sample request

// Source bucket name, including appid
String bucketName = "examplebucket-1250000000";
BucketRefererConfiguration configuration = cosClient.getBucketRefererConfiguration(bucketName);
if (configuration == null) {
  System.out.printf("bucket %s does not have referer configuration\n", bucketName);
  return;
}
System.out.printf("status: %s\n", configuration.getStatus());
System.out.printf("referer type: %s\n", configuration.getRefererType());
System.out.printf("empty referer config: %s\n", configuration.getEmptyReferConfiguration());
for (String domain : configuration.getDomainList()) {
  System.out.printf("domain: %s\n", domain);
}

Parameter description

Response description

• Success: The referer allowlist or blocklist of the bucket is returned.
• Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.