tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to custom domains.

Setting Custom Domains

Description

This API is used to set a custom domain for a bucket.

Method prototype

public Guzzle\Service\Resource\Model PutBucketDomain(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.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 succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo($e);
}

Parameter description

Error codes

The following describes some common errors that may occur when you call this API:

Querying a Custom Domain

Description

This API is used to query the custom domain set for a bucket.

Method prototype

public Guzzle\Service\Resource\Model GetBucketDomain(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.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 succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo($e);
}

Parameter description

Sample response

GuzzleHttp\Command\Result Object
(
  [DomainRules] => Array
      (
          [0] => Array
              (
                  [Status] => ENABLED
                  [Name] => www.qq.com
                  [Type] => REST
              )
       )
  [DomainTxtVerification] => tencent-cloud-cos-verification=9d2258433b1f38c7dd4b29fe272d2128
)

Response description