Overview

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

Note：

COS PHP SDK v2.3.2 or later is required. Earlier versions may contain bugs and need to be upgraded to the latest version when used.

Setting a bucket referer

Description

This API is used to set the referer allowlist/blocklist for a bucket.

Method prototype

public Guzzle\Service\Resource\Model putBucketReferer(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->putBucketReplication(array(
          'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
          'Status' => 'Enabled', // Whether to enable hotlink protection. Enumerated values: “Enabled”, “Disabled”
          'RefererType' => 'White-List', // Hotlink protection type. Enumerated values: “Black-List”, “White-List”
          'DomainList' => array(
              'Domains' => array(
                   '*.qq.com', // A single domain
                   '*.qcloud.com', // A single domain
              )
          ), // Domain list
          'EmptyReferConfiguration' => 'Allow', // Whether to allow access with an empty referer. Enumerated values: “Allow”, “Deny” (default)
      ),      
  ); 
  // Request succeeded    
  print_r($result);
} catch (\Exception $e) {   
  // Request failed
  echo($e);
}

Parameter description

Querying a bucket referer

Description

This API is used to query the referer allowlist/blocklist of a bucket.

Method prototype

public Guzzle\Service\Resource\Model getBucketReferer(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));

try {
  $result = $cosClient->getBucketReferer(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
  )); 
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Parameter description

Sample response

GuzzleHttp\Command\Result Object
(
   [RequestId] => NjE0NTk2ZWVfZmQzNDJjMGJfMWNiNmVfN2Y1MWQx
   [ContentType] => application/xml
   [ContentLength] => 260
   [Status] => Enabled
   [RefererType] => White-List
   [EmptyReferConfiguration] => Allow
   [DomainList] => Array
       (
           [Domain] => Array
               (
                   [0] => *.qq.com
                   [1] => *.qcloud.com
               )
        )
    [Bucket] => examplebucket-1250000000
   [Location] => examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/
)