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

设置桶的自定义域名(Node.js SDK)

功能说明

设置OBS桶的自定义域名。

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

接口约束

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

方法定义

ObsClient.setBucketCustomDomain(params)

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

String

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

DomainName

String

可选

参数解释：

自定义域名。

约束限制：

无

取值范围：

无

默认取值：

无

DomainBody

CustomDomainCertificateConfig

可选

参数解释：

自定义域名证书配置。

约束限制：

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

取值范围：

CustomDomainCertificateConfig

默认取值：

无
表2 CustomDomainCertificateConfig

参数名称

参数类型

是否必选

描述

Name

String

是

参数解释：

证书名称。

约束限制：

无

取值范围：

长度为3~63的字符串。

默认取值：

无

CertificateId

String

否

参数解释：

CCM上的证书证书ID。

约束限制：

无

取值范围：

长度为16的字符串。

默认取值：

无

Certificate

String

是

参数解释：

证书内容，可包含中间证书及根证书。若CertificateChain字段传入证书链，则该字段只取证书本身。回车换行需要使用转义字符\n或者\r\n替换。

约束限制：

无

取值范围：

无

默认取值：

无

CertificateChain

String

否

参数解释：

证书链，非必填，可通过Certificate字段传入。回车换行需要使用转义字符\n或者\r\n替换。

约束限制：

无

取值范围：

无

默认取值：

无

PrivateKey

String

是

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

返回结果说明

表3 返回结果

参数类型

描述

表4

说明：

该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。

参数解释：

接口返回信息，详见表4。
表4 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释：

接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。

InterfaceResult

表6

参数解释：

操作成功后的结果数据，详见表6。

约束限制：

当Status大于300时为空。
表5 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服务端返回的详细错误码。
表6 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释：

OBS服务端返回的请求ID。

相关文档