绑定域名 - AssociateDomainV2
功能介绍
用户自定义的域名，需要CNAME到API分组的子域名上才能生效。
每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id | 是 | String | 实例ID |
group_id | 是 | String | 分组的编号 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
min_ssl_version | 否 | String | 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 |
is_http_redirect_to_https | 否 | Boolean | 是否开启http到https的重定向，false为关闭，true为开启，默认为false |
url_domain | 是 | String | 自定义域名。长度为0-255位的字符串，需要符合域名规范（即符合正则'^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.){1,7}[a-zA-Z]{2,64}\.?$'或者符合正则'^[*](\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?){1,6}\.[a-zA-Z]{2,64}\.?$'）。 |
响应参数
状态码：201
参数 | 参数类型 | 描述 |
|---|---|---|
url_domain | String | 自定义域名 |
id | String | 自定义域名的编号 |
status | Integer | CNAME解析状态
|
min_ssl_version | String | 支持的最小SSL版本 |
is_http_redirect_to_https | Boolean | 是否开启http到https的重定向，false为关闭，true为开启，默认为false |
verified_client_certificate_enabled | Boolean | 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
为API分组绑定一个域名
{
"url_domain" : "www.company.com"
} 响应示例
状态码：201
Created
{
"url_domain" : "www.company.com",
"id" : "c5e0d5ba62a34d26ad5c709ae22c1a17",
"status" : 3,
"min_ssl_version" : "TLSv1.1",
"is_http_redirect_to_https" : false,
"verified_client_certificate_enabled" : false
} 状态码：400
Bad Request
{
"error_code" : "APIG.2024",
"error_msg" : "Invalid URL domain name"
} 状态码：401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码：403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} 状态码：404
Not Found
{
"error_code" : "APIG.3001",
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
} 状态码：500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} 状态码
状态码 | 描述 |
|---|---|
201 | Created |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
错误码
请参见错误码。
