Binding a Domain Name¶
Function¶
A user-defined domain name takes effect only after an A record set has been added. For details, see section "Adding an A Record Set" in the Domain Name Service User Guide.
An API group can be bound with a maximum of five domain names. After you bind a domain name to an API group, APIs in the group can be called using the domain name.
Calling Method¶
For details, see Calling APIs.
URI¶
POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Gateway ID, which can be obtained from the gateway information on the APIG console. |
group_id | Yes | String | API group ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
min_ssl_version | No | String | Minimum SSL version. TLS 1.1 and TLS 1.2 are supported. Default: TLSv1.1 Enumeration values:
|
is_http_redirect_to_https | No | Boolean | Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false. Default: false |
url_domain | Yes | String | Custom domain name. It can contain a maximum of 255 characters and must comply with domain name specifications. |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
url_domain | String | Custom domain name. |
id | String | Domain ID. |
status | Integer | CNAME resolution status.
Enumeration values:
|
min_ssl_version | String | Minimum SSL version supported. |
is_http_redirect_to_https | Boolean | Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false. Default: false |
verified_client_certificate_enabled | Boolean | Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 403
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 404
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
Binding a domain name to an API group
{
"url_domain" : "www.company.com"
}
Example Responses¶
Status code: 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
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2024",
"error_msg" : "Invalid URL domain name"
}
Status code: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Status code: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Status code: 404
Not Found
{
"error_code" : "APIG.3001",
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
201 | Created |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.