# 设置桶的自定义域名
#### 功能介绍
设置桶的自定义域名。
#### 接口约束
- 您必须是桶拥有者或拥有设置桶的自定义域名配置的权限，才能设置桶的自定义域名配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:SetBucketCustomDomainConfiguration权限，如果使用桶策略则需授予SetBucketCustomDomainConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。
 
#### 命令结构
- Windows操作系统
  ```
  obsutil custom-domain obs://bucket -method=put -cname=xxx [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
  ```
  
- macOS/Linux操作系统
  ```
  ./obsutil custom-domain obs://bucket -method=put -cname=xxx [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
  ```
  
 
#### 运行示例
以Windows操作系统为例，运行**obsutil custom-domain obs://test-bucket -method=put -cname=www.obs-example.com** ，指定给桶test-bucket绑定www.obs-example.com自定义域名。
```
obsutil custom-domain obs://test-bucket -method=put -cname=www.obs-example.com 
Start at 2024-09-30 07:59:28.8675681 +0000 UTC
Put customDomain configuration succeed for bucket [test-bucket], customDomain is [www.obs-example.com], requestId is [00000199765243C44018D688E9F5CFF5]
```
#### 参数说明
| **参数**          | **约束**       | **描述**                                                                                                                                        |
|:---|:---|:---|
| bucket            | 必选         | 桶名。                                                                                                                                           |
| method          | 必选        | 指定方法，设置桶的自定义域名时该值为put。                                                                                                                       |
| cname           | 必选        | 指定桶的自定义域名。 一个桶最多可以设置30个自定义域名，一个自定义域名只能被一个桶使用。 一个桶最多可以设置100个自定义域名，一个自定义域名只能被一个桶使用。 |
| certificateName | 附加参数，可选     | 指定证书名称，字符长度为3\~63位, 请输入英文字符，数字，下划线，中划线，英文句点。                                                                                               |
| certificateId  | 附加参数，可选    | 指定证书ID。                                                                                                                                    |
| certificate    | 附加参数，可选  | 指定证书内容。可包含中间证书及根证书。若certificate_chain字段传入证书链，则该字段只取证书本身。如果证书内容出现换行，需要使用转义字符\\n或者\\r\\n替换。                                                   |
| certificateChain | 附加参数，可选    | 指定证书链，可通过certificate字段传入。如果证书链内容出现换行，需要使用转义字符\\n或者\\r\\n替换。                                                                                   |
| privateKey      | 附加参数，可选 | 指定证书私钥。不能上传带有口令保护的私钥。如果证书私钥内容出现换行，需要使用转义字符\\n或者\\r\\n替换。                                                                                     |
| config           | 附加参数，可选     | 运行当前命令时的自定义配置文件。可支持的配置参数请参考[配置参数说明](https://support.huaweicloud.com/utiltg-obs/obs_11_0035.html)。                               |
| e               | 附加参数，可选   | 指定终端节点。                                                                                                                                      |
| i               | 附加参数，可选    | 指定用户的AK。                                                                                                                                     |
| k                | 附加参数，可选    | 指定用户的SK。                                                                                                                                    |
| t               | 附加参数，可选   | 指定用户的securitytoken。                                                                                                                          |
   
#### 相关链接
- 关于设置桶的自定义域名的API说明，请参见[设置桶的自定义域名](https://support.huaweicloud.com/api-obs/obs_04_0059.html)。
- 设置桶的自定义域名过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。