tencent cloud

Overview

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

Setting custom domain names

Feature description

This API is used to bind a custom domain name to an existing bucket.

Sample request

cos.putBucketDomain({
    Bucket: 'examplebucket-1250000000',  /* Required */
    Region: 'ap-beijing',    /* Required */
    DomainRule: [{
        Status: "DISABLED",
        Name: "www.example.com",
        Type: "REST"
    },
    {
        Status: "DISABLED",
        Name: "www.example.net",
        Type: "WEBSITE",
    }]
}, function(err, data) {
    console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }

Querying custom domain names

Feature description

This API is used to query the custom domain name associated with a bucket.

Sample request

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

Sample response

{
    "DomainRule": [{
        "Status": "DISABLED",
        "Name": "www.example.com",
        "Type": "REST"
    }, {
        "Status": "DISABLED",
        "Name": "www.example.net",
        "Type": "WEBSITE"
    }],
    "statusCode": 200,
    "headers": {}
}

Parameter description

Callback function description

function(err, data) { ... }

Deleting custom domain names

Feature description

This API is used to delete the custom domain name configured for a bucket.

Sample request

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

Parameter description

Callback function description

function(err, data) { ... }