tencent cloud

Overview

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

Setting Bucket Referer Configuration

Description

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

Sample request

cos.putBucketReferer({
   Bucket: 'examplebucket-1250000000', /* Required */
   Region: 'COS_REGION',     /* Bucket region. Required */
   RefererConfiguration: {
       Status: 'Enabled',
       RefererType: 'White-List',
       DomainList: {
           Domains: [
               '*.qq.com',
               '*.qcloud.com',
           ]
       },
       EmptyReferConfiguration: 'Allow',
   }
}, function(err, data) {
   console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }

Querying Bucket Referer Configuration

Description

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

Sample request

cos.getBucketReferer({
   Bucket: 'examplebucket-1250000000', /* Required */
   Region: 'COS_REGION',     /* Bucket region. Required */
}, function(err, data) {
   console.log(err || data);
});

Sample response

{
  "RefererConfiguration": {
      "Status": "Enabled",
      "RefererType": "White-List",
      "DomainList": {
          "Domains": [
              "*.qq.com",
              "*.qcloud.com"
          ]
      },
      "EmptyReferConfiguration": "Allow"
  },
  "statusCode": 200,
  "headers": {},
}

Parameter description

Callback function description

function(err, data) { ... }