设置桶的自定义域名
功能介绍
OBS使用PUT操作为桶设置自定义域名，设置成功之后，用户访问桶的自定义域名就能访问到桶。
要使用该接口，使用者要求必须是桶的所有者，或者是桶所有者的子用户且具有设置自定义域名的权限。
必须保证此自定义域名通过DNS能够正确解析到OBS服务。
请求消息样式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
PUT /?customdomain=domainname HTTP/1.1 User-Agent: curl/7.29.0 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: date Authorization: authorization string Content-Length: length <CustomDomainConfiguration> <Name>name</Name> <CertificateId>certificateId</CertificateId> <Certificate>certificate</Certificate> <CertificateChain>certificateChain</CertificateChain> <PrivateKey>privateKey</PrivateKey> </CustomDomainConfiguration> |
请求参数
|
参数 |
描述 |
是否必选 |
|---|---|---|
|
customdomain |
参数解释： 桶的自定义域名。 类型：String，必须满足域名规则。 约束限制： 一个桶最多可以设置100个自定义域名，一个自定义域名只能被一个桶使用。绑定证书时，证书的生效时间为60秒。 取值范围： 最长256字节。 默认取值： 无 |
是 |
请求消息头
该请求使用公共消息头，具体参见表3。
请求消息元素
请求消息元素为可选，如果请求消息元素为空，会覆盖同一自定义域名下已绑定的证书
|
参数 |
描述 |
是否必选 |
|---|---|---|
|
Name |
参数解释： 证书名称。字符长度为3~63位, 请输入英文字符，数字，下划线，中划线，英文句点。 类型：String 取值范围： 最小长度：3 最大长度：63 |
是 |
|
CertificateId |
参数解释： 证书ID。非必选，未携带时自动生成证书ID。 类型：String 取值范围： 最小长度：16 最大长度：16 |
否 |
|
Certificate |
参数解释： 证书内容。可包含中间证书及根证书。若certificate_chain字段传入证书链，则该字段只取证书本身。回车换行需要使用转义字符\n或者\r\n替换。 类型：String 取值范围： 最小长度：0 最大长度：4096 |
是 |
|
CertificateChain |
参数解释： 证书链。非必填，可通过certificate字段传入。回车换行需要使用转义字符\n或者\r\n替换。 类型：String 取值范围： 最小长度：0 最大长度：8192 |
否 |
|
PrivateKey |
参数解释： 证书私钥。不能上传带有口令保护的私钥，回车换行需要使用转义字符\n或者\r\n替换。 类型：String 取值范围： 最小长度：0 最大长度：4096 |
是 |
响应消息样式
1 2 3 4 5 6 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: request id x-obs-id-2: id Date: date Content-Length: 0 |
响应消息头
该请求的响应消息使用公共消息头，具体请参考表1。
响应消息元素
该请求的响应消息中不带有响应元素。
错误响应消息
无特殊错误，所有错误已经包含在表2中。
请求示例
绑定自定义域名
1 2 3 4 5 6 7 |
PUT /?customdomain=obs.ccc.com HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: Mon, 14 Jan 2019 08:31:36 +0000 Authorization: OBS UDSIAMSTUBTEST000094:u2kJF4kENs6KlIDcAZpAKSKPtnc= Content-Length: 0 |
绑定自定义域名并且绑定服务端证书请求示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
PUT /?customdomain=obs.ccc.com HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: Mon, 14 Jan 2019 08:31:36 +0000 Authorization: OBS UDSIAMSTUBTEST000094:u2kJF4kENs6KlIDcAZpAKSKPtnc= Content-Length: 314 <CustomDomainConfiguration> <Name>exampleCertName</Name> <CertificateId>exampleCertificateId</CertificateId> <Certificate>exampleCertificate</Certificate> <CertificateChain>exampleCertificateChain</CertificateChain> <PrivateKey>examplePrivateKey</PrivateKey> </CustomDomainConfiguration> |
响应示例
1 2 3 4 5 6 |
HTTP/1.1 200 OK Server: OBS x-obs-request-id: 000001697692CC5380E9D272E6D8F830 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSsfu2GXj9gScHhFnrrTPY2cFOEZuvta Date: Wed, 13 Mar 2019 10:22:05 GMT Content-Length: 0 |
