Release Notes
Announcements
API | Operation | Description |
PUT Bucket domain | Setting a custom domain | Sets a custom domain for a bucket |
GET Bucket domain | Querying a custom domain | Queries the custom domain of a bucket |
public Guzzle\\Service\\Resource\\Model PutBucketDomain(array $args = array());
<?phprequire dirname(__FILE__) . '/../vendor/autoload.php';$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.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->putBucketDomain(array('Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket'DomainRules' => array(array('Name' => 'www.qq.com','Status' => 'ENABLED','Type' => 'REST','ForcedReplacement' => 'CNAME',),// ... repeated),));// Request succeededprint_r($result);} catch (\\Exception $e) {// Request failedecho($e);}
Parameter | Description | Type |
Bucket | Bucket for custom domain name configuration, in the format of BucketName-APPID. For more information, please see Bucket Naming Conventions. | String |
Name | Custom domain name | String |
Status | Status of the domain name. Valid values: ENABLED, DISABLED | String |
Type | Type of the origin server to bind. Valid values: REST, WEBSITE | String |
ForcedReplacement | Replaces existing configurations. Valid values: CNAME, TXT | String |
Status Code | Description |
HTTP 409 Conflict | The domain record already exists, and forced overwrite is not specified in the request; OR the domain record does not exist, and forced overwrite is specified in the request |
HTTP 451 Unavailable For Legal Reasons | The domain does not have an ICP filing in the Chinese mainland |
public Guzzle\\Service\\Resource\\Model GetBucketDomain(array $args = array());
<?phprequire dirname(__FILE__) . '/../vendor/autoload.php';$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.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->getBucketDomain(array('Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket));// Request succeededprint_r($result);} catch (\\Exception $e) {// Request failedecho($e);}
Parameter | Description | Type |
Bucket | Bucket for custom domain name query, in the format of BucketName-APPID. For more information, please see Bucket Naming Conventions. | String |
GuzzleHttp\\Command\\Result Object([DomainRules] => Array([0] => Array([Status] => ENABLED[Name] => www.qq.com[Type] => REST))[DomainTxtVerification] => tencent-cloud-cos-verification=9d2258433b1f38c7dd4b29fe272d2128)
Parameter | Description | Type |
Name | Custom domain name | String |
Status | Status of the domain name. Valid values: ENABLED, DISABLED | String |
Type | Type of the origin server to bind. Valid values: REST, WEBSITE | String |
ForcedReplacement | Replaces existing configurations. Valid values: CNAME, TXT | String |
DomainTXTVerification | Endpoint verification information. This field is an MD5 checksum of a character string in the format: cos[Region][BucketName-APPID][BucketCreateTime], where Region is the bucket region and BucketCreateTime is the time the bucket was created in GMT format | String |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback