文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 设置桶的自定义域名(Python SDK)
更新时间：2026-03-05 GMT+08:00
查看PDF
分享

设置桶的自定义域名(Python SDK)

功能介绍

设置OBS桶的自定义域名。

接口约束

  • 您必须是桶拥有者或拥有设置桶的自定义域名的权限，才能设置桶的自定义域名。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketCustomDomainConfiguration权限，如果使用桶策略则需授予PutBucketCustomDomainConfiguration权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

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

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

取值范围：

无

默认取值：

无

domainName

str

必选

参数解释：

桶的自定义域名。

约束限制：

一个桶最多可以设置100个自定义域名，一个自定义域名只能被一个桶使用。绑定证书时，证书的生效时间为60秒。

取值范围：

长度为0~256的字符串。

默认取值：

无

certificateInfo

CustomDomainConfiguration

可选

参数解释：

自定义域名证书配置。

约束限制：

自定义域名证书配置只支持https协议请求。

取值范围：

取值范围请详见CustomDomainConfiguration。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

取值范围请详见自定义头域。

默认取值：

无
表2 CustomDomainConfiguration

参数名称

参数类型

是否必选

描述

name

str

必选

参数解释：

证书名称。

约束限制：

仅支持输入大写英文字符、小写英文字符、数字、下划线、中划线、英文句点。

取值范围：

长度为3~63的字符串。

默认取值：

无

certificateId

str

可选

参数解释：

CCM上的证书证书ID。未携带CertificateId时自动生成证书ID。

约束限制：

如果用户使用CCM服务托管证书，则证书ID必须为CCM上的证书ID。如果用户需要自己运维管理证书，则请求时不需要主动设置证书ID。

取值范围：

由字母和数字组成的长度为16的字符串。

默认取值：

系统自动生成随机16个字符的证书ID。

certificate

str

必选

参数解释：

证书内容，可包含中间证书及根证书。

约束限制：

  • 如果CertificateChain字段传入证书链，则Certificate字段只取证书本身。
  • 回车换行需要使用转义字符\n或者\r\n替换。

取值范围：

长度为0~65536的字符串。

默认取值：

不涉及

certificateChain

str

可选

参数解释：

证书链。可通过Certificate字段传入。

约束限制：

回车换行需要使用转义字符\n或者\r\n替换。

取值范围：

长度为0~8192的字符串。

默认取值：

不涉及

privateKey

str

必选

参数解释：

证书私钥。

约束限制：

  • 不支持上传带有口令保护的私钥。
  • 回车换行需要使用转义字符\n或者\r\n替换。

取值范围：

长度为0~4096的字符串。

默认取值：

不涉及

certificateType

str

可选

参数解释：

证书类型。

约束限制：

取值大小写敏感。

取值范围：

  • server：服务端证书
  • server_sm：服务端国密证书
  • client：客户端CA证书

默认取值：

不设置该参数的取值时默认为server。

encCertificate

str

可选

参数解释：

国密证书的加密证书内容。

约束限制：

回车换行需要使用转义字符\n或者\r\n替换。

取值范围：

长度为0~65536的字符串。

默认取值：

不涉及

encPrivateKey

str

可选

参数解释：

国密证书的加密私钥。

约束限制：

  • 不支持上传带有口令保护的私钥。
  • 回车换行需要使用转义字符\n或者\r\n替换。

取值范围：

长度为0~4096的字符串。

默认取值：

不涉及

deleteCertificate

str

可选

参数解释：

证书操作类型，是否删除证书。

约束限制：

不涉及

取值范围：

  • false：上传证书操作。
  • true：删除证书操作，删除指定类型的证书。

默认取值：

false

返回结果说明

表3 返回结果

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表4 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例：设置桶的自定义域名并配置国际证书

本示例用于设置examplebucket桶的自定义域名并配置国际证书。

 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
 
from obs import ObsClient, CustomDomainConfiguration
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = 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')
    bucketName = 'examplebucket'
    domainName = 'example.domain.name.com'
    # 设置桶的自定义域名配置
    resp = obsClient.setBucketCustomDomain(bucketName, domainName, certificate_info)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    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:
    print('Set Bucket CustomDomain Failed')
    print(traceback.format_exc())

代码样例：设置桶的自定义域名并配置国密证书

本示例用于设置examplebucket桶的自定义域名并配置国密证书。

 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
 
from obs import ObsClient, CustomDomainConfiguration
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = 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')

    bucketName = 'examplebucket'
    domainName = 'example.domain.name.com'
    resp = obsClient.setBucketCustomDomain(bucketName, domainName, certificate_info)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    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:
    print('Set Bucket CustomDomain Failed')
    print(traceback.format_exc())

相关链接

  • 关于设置桶的自定义域名的API说明，请参见设置桶的自定义域名。
  • 设置桶的自定义域名过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

相关文档