Help Center/ Object Storage Service/ SDK Reference/ Python/ Bucket-Related APIs (SDK for Python)/ Custom Domain Names (SDK for Python)/ Configuring a Custom Domain Name for a Bucket (SDK for Python)
Updated on 2026-07-31 GMT+08:00
View PDF
Share

Configuring a Custom Domain Name for a Bucket (SDK for Python)

Function

This API sets a custom domain name for an OBS bucket.

Restrictions

Method

ObsClient.setBucketCustomDomain(bucketName, domainName, certificateInfo, extensionHeaders)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

str

Yes

Explanation:

Bucket name.

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.

Value range:

None

Default value:

None

domainName

str

Yes

Explanation:

Custom domain name of a bucket.

Restrictions:

A bucket can have a maximum of 100 domain names. One custom domain name can be used for only one bucket. When a certificate is bound, the certificate takes effect in 60 seconds.

Value range:

The value is a string of 0 to 256 characters.

Default value:

None

certificateInfo

CustomDomainConfiguration

No

Explanation:

Custom domain name certificate configuration.

Restrictions:

Only HTTPS requests are supported.

Value range:

See CustomDomainConfiguration.

Default value:

None

extensionHeaders

dict

No

Explanation:

Extension headers.

Value range:

See User-defined Headers.

Default value:

None
Table 2 CustomDomainConfiguration

Parameter

Type

Mandatory (Yes/No)

Description

name

str

Yes

Explanation:

Certificate name.

Restrictions:

Only uppercase letters, lowercase letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

Value range:

The value is a string of 3 to 63 characters.

Default value:

None

certificateId

str

No

Explanation:

Certificate ID on the CCM. If no certificate ID is specified, the system automatically generates a certificate ID.

Restrictions:

If you use the CCM service to host a certificate, the specified certificate ID must be the same as that on CCM. If you need to manage the certificates by yourself, do not set the certificate ID in the request.

Value range:

The value is a string of 16 characters consisting of letters and digits.

Default value:

An automatically generated random certificate ID that consists of 16 characters

certificate

str

Yes

Explanation:

Certificate content, which can contain intermediate and root certificates.

Restrictions:

  • If CertificateChain contains a certificate chain, only the certificate itself will be extracted from Certificate.
  • Use escape characters \n or \r\n to replace line breaks.

Value range:

The value is a string of 0 to 65,536 characters.

Default value:

N/A

certificateChain

str

No

Explanation:

Certificate chain. The value can be passed through the Certificate field.

Restrictions:

Use escape characters \n or \r\n to replace line breaks.

Value range:

The value is a string of 0 to 8,192 characters.

Default value:

N/A

privateKey

str

Yes

Explanation:

Private key of a certificate.

Restrictions:

  • Private keys protected by passwords cannot be uploaded.
  • Use escape characters \n or \r\n to replace line breaks.

Value range:

The value is a string of 0 to 4,096 characters.

Default value:

N/A

certificateType

str

No

Explanation:

Certificate type.

Restrictions:

The value is case sensitive.

Value range:

  • server: server certificate
  • server_sm: server SM certificate
  • client: client CA certificate

Default value:

If this parameter is not set, the default value server is used.

encCertificate

str

No

Explanation:

Content of the SM encryption certificate.

Restrictions:

Use escape characters \n or \r\n to replace line breaks.

Value range:

The value is a string of 0 to 65,536 characters.

Default value:

N/A

encPrivateKey

str

No

Explanation:

Private encryption key of the SM certificate.

Restrictions:

  • Private keys protected by passwords cannot be uploaded.
  • Use escape characters \n or \r\n to replace line breaks.

Value range:

The value is a string of 0 to 4,096 characters.

Default value:

N/A

deleteCertificate

str

No

Explanation:

Certificate operation type, indicating whether to delete the certificate.

Restrictions:

N/A

Value range:

  • false: Upload the certificate.
  • true: Delete the certificate of the specified type.

Default value:

false

Responses

Table 3 Responses

Type

Description

GetResult

Explanation:

SDK common results
Table 4 GetResult

Parameter

Type

Description

status

int

Explanation:

HTTP status code

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code.

Default value:

None

reason

str

Explanation:

Reason description

Default value:

None

errorCode

str

Explanation:

Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

errorMessage

str

Explanation:

Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

requestId

str

Explanation:

Request ID returned by the OBS server

Default value:

None

indicator

str

Explanation:

Error indicator returned by the OBS server

Default value:

None

hostId

str

Explanation:

Requested server ID. If the value of status is less than 300, this parameter is left blank.

Default value:

None

resource

str

Explanation:

Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank.

Default value:

None

header

list

Explanation:

Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header.

Default value:

None

body

object

Explanation:

Result content returned after the operation is successful. If the value of status is larger than 300, this parameter is left blank. The value varies with the API being called. For details, see the sections "Bucket-Related APIs" and "Object-Related APIs".

Default value:

None

Sample Code: Configuring a Custom Domain Name for a Bucket and Configuring an International Certificate

This example configures a custom domain name for bucket examplebucket and configures an international certificate.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
import os
import traceback

from obs import ObsClient, CustomDomainConfiguration

# Obtain an AK/SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# If you use a temporary AK/SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK/SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    certificate_info = CustomDomainConfiguration(name='exampleCertName',
                                                 certificateId='1234512345123450',
                                                 certificate='exampleDomainCertificate',
                                                 certificateChain='exampleDomainCertificateChain',
                                                 privateKey='exampleDomainCertificatePrivateKey')
    bucket_name = 'examplebucket'
    domain_name = 'example.domain.name.com'
    # Configure a custom domain name for the bucket.
    resp = obs_client.setBucketCustomDomain(bucket_name, domain_name, certificate_info)

    # If status code 2xx is returned, the API was called successfully. Otherwise, the call failed.
    if resp.status < 300:
        print('Set Bucket CustomDomain Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket CustomDomain Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Set Bucket CustomDomain Failed')
    print(traceback.format_exc())

Sample Code: Configuring a Custom Domain Name for a Bucket and Configuring an SM Certificate

This example configures a custom domain name for bucket examplebucket and configures an SM certificate.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
import os
import traceback

from obs import ObsClient, CustomDomainConfiguration

# Obtain an AK/SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# If you use a temporary AK/SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK/SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) 
try: 
    certificate_info = CustomDomainConfiguration(name='exampleCertName', 
                                                 certificateId='1234512345123450', 
                                                 certificate='exampleCertificate', 
                                                 certificateChain='exampleCertificateChain', 
                                                 privateKey='exampleCertificatePrivateKey', 
                                                 certificateType='server_sm', 
                                                 encCertificate='exampleEncCertificate', 
                                                 encPrivateKey='exampleEncPrivateKey') 

    bucket_name = 'examplebucket' 
    domain_name = 'example.domain.name.com' 
    resp = obs_client.setBucketCustomDomain(bucket_name, domain_name, certificate_info) 

    # If status code 2xx is returned, the API was called successfully. Otherwise, the call failed.
    if resp.status < 300: 
        print('Set Bucket CustomDomain Succeeded') 
        print('requestId:', resp.requestId) 
    else: 
        print('Set Bucket CustomDomain Failed') 
        print('requestId:', resp.requestId) 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage) 
except Exception: 
    print('Set Bucket CustomDomain Failed') 
    print(traceback.format_exc())

Helpful Links