tencent cloud

Feature Overview

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

Setting Custom Domains

Feature description

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

Method prototype

func (s *BucketService) PutDomain(ctx context.Context, opt *BucketPutDomainOptions) (*Response, error)

Sample request

package main
import (
   "context"
   "fmt"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
       },
   })
   opt := &cos.BucketPutDomainOptions{
       Rules: []cos.BucketDomainRule{
           {
               Status:            "ENABLED",
               Name:              "www.example.com",
               Type:              "REST",
               ForcedReplacement: "CNAME",
           },
       },
   }
   _, err := client.Bucket.PutDomain(context.Background(), opt)
   if err != nil{
       fmt.Println(err)
   }
}

Field description

type BucketDomainRule struct {
  Status            string
  Name              string
  Type              string
  ForcedReplacement string
}
type BucketPutDomainOptions struct {
  XMLName                xml.Name
  Rules   []BucketDomainRule
}

Error codes

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

Querying a Custom Domain

Feature description

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

Method prototype

func (s *BucketService) GetDomain(ctx context.Context) (*BucketGetDomainResult, *Response, error)

Sample request

package main
import (
   "context"
   "fmt"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
       },
   })
   v, _, err := client.Bucket.GetDomain(context.Background())
   if err != nil{
       fmt.Println(err)
   }
   fmt.Println(v)
}

Response description

type BucketGetDomainResult BucketPutDomainOptions

Deleting Custom Domains

This API (DELETE Bucket domain) is used to delete all custom domains bound to a bucket.

Method prototype

func (s *BucketService) DeleteDomain(ctx context.Context) (*Response, error)

Sample request

package main
import (
   "context"
   "fmt"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main(){
   // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
   // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, visit https://www.tencentcloud.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's `SecretId`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretID: os.Getenv("SECRETID"),  // User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
           // Environment variable `SECRETKEY` refers to the user's `SecretKey`, which can be viewed in the CAM console at https://console.tencentcloud.com/cam/capi.
           SecretKey: os.Getenv("SECRETKEY"),  // User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit  https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.
       },
   })
   _, err := client.Bucket.DeleteDomain(context.Background())
   if err != nil{
       fmt.Println(err)
   }
}