Overview

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

Setting Custom Domain Name

Feature description

This API (PUT Bucket domain) is used to configure a custom domain name for a bucket.

Method prototype

put_bucket_domain(Bucket, DomainConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_domain(
    Bucket='bucket',
    DomainConfiguration={
        'DomainRule': [
            {
                'Name': 'example.com',
                'Type': 'REST'|'WEBSITE'|'ACCELERATE',
                'Status': 'ENABLED'|'DISABLED',
                'ForcedReplacement': 'CNAME'|'TXT'
            },
        ]
    }
)

Parameter description

Returned result description

The returned value of this method is None.

Returned error code description

Some frequent special errors that may occur with this request are listed below:

Querying Custom Domain Name

Feature description

This API (GET Bucket domain) is used to query the custom domain name information of a bucket.

Method prototype

get_bucket_domain(Bucket, **kwargs)

Sample request

response = client.get_bucket_domain(
    Bucket='examplebucket-1250000000'
)

Parameter description

Returned result description

Custom domain name configuration of bucket in dict type.

{
    'x-cos-domain-txt-verification': 'string',
    'DomainRule': [
        {
            'Name': 'example.com',
            'Type': 'REST'|'WEBSITE'|'ACCELERATE',
            'Status': 'ENABLED'|'DISABLED',
            'ForcedReplacement': 'CNAME'|'TXT'
        },
    ]
}

Deleting Custom Domain Name

Feature description

This API (DELETE Bucket domain) is used to delete the existing custom domain name configuration of a specified bucket.

Method prototype

delete_bucket_domain(Bucket, **kwargs)

Sample request

response = client.delete_bucket_domain(
    Bucket='examplebucket-1250000000'
)

Parameter description

Returned result description

The returned value of this method is None.