文档首页/ 对象存储服务 OBS/ SDK参考/ BrowserJS/ 桶相关接口/ 自定义域名/ 获取桶的自定义域名
更新时间：2026-07-10 GMT+08:00
查看PDF
分享

获取桶的自定义域名

功能介绍

获取OBS桶的自定义域名列表。

接口约束

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

方法定义

ObsClient.getBucketCustomDomain(params)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

String

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

返回结果说明

表2 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释：

OBS服务端返回的HTTP状态码。

取值范围：

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

Code

string

参数解释：

OBS服务端返回的错误码。

Message

string

参数解释：

OBS服务端返回的错误描述。

HostId

string

参数解释：

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释：

OBS服务端返回的请求ID。

Id2

string

参数解释：

OBS服务端返回的请求ID2。

Indicator

string

参数解释：

OBS服务端返回的详细错误码。
表3 ListBucketCustomDomainsResult

参数名称

参数类型

描述

Domains

Domains

必选

参数解释：

桶的QoS配置。

取值范围：

详见表4。

默认取值：

无
表4 Domains

参数名称

参数类型

描述

DomainName

str

参数解释：

自定义域名。

取值范围：

长度为0~256的字符串。

Value

str

参数解释：

自定义域名的创建时间。

取值范围：

  • 格式要求为UTC时间，并符合ISO 8601标准。例如：2018-01-01T00:00:00.000Z，表示创建时间为2018-01-01T00:00:00.000Z。
  • 长度为24的字符串。

CertificateId

str

参数解释：

自定义域名绑定的证书ID。

取值范围：

长度为16的字符串。

CertName

str

参数解释：

自定义域名绑定的证书名称。

取值范围：

长度为3~63的字符串。

CertificateType

str

参数解释：

自定义域名绑定的证书类型。

取值范围：

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

ExpiredTime

str

参数解释：

证书类型为server或者server_sm时，返回自定义域名绑定的证书过期时间。

取值范围：

格式要求为UTC时间，并符合ISO 8601标准。例如：2018-01-01T00:00:00.000Z，表示创建时间为2018-01-01T00:00:00.000Z。
父主题： 自定义域名

相关文档