设置桶的自定义域名
功能介绍
设置OBS桶的自定义域名。
接口约束
- 您必须是桶拥有者或拥有设置桶加密配置的权限,才能设置桶加密配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:SetBucketCustomDomain权限,如果使用桶策略则需授予SetBucketCustomDomain权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.setBucketCustomDomain(params)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| DomainName | String | 必选 | 参数解释: 自定义域名。 约束限制: 无 取值范围: 无 默认取值: 无 |
| 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替换。 约束限制: 无 取值范围: 无 默认取值: 无 |
| CertificateType | str | 可选 | 参数解释: 证书类型。 约束限制: 取值大小写敏感。 取值范围:
默认取值: 不设置该参数的取值时默认为server。 |
| ENCCertificate | str | 可选 | 参数解释: 国密证书的加密证书内容。 约束限制: 回车换行需要使用转义字符\n或者\r\n替换。 取值范围: 长度为0~65536的字符串。 默认取值: 不涉及 |
| ENCPrivateKey | str | 可选 | 参数解释: 国密证书的加密私钥。 约束限制:
取值范围: 长度为0~4096的字符串。 默认取值: 不涉及 |
| DeleteCertificate | str | 可选 | 参数解释: 证书操作类型,是否删除证书。 约束限制: 不涉及 取值范围:
默认取值: false |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
| 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服务端返回的详细错误码。 |