Unbinding a Domain Name's SSL Certificates
Function
This API is used to unbind a domain name's SSL certificates. Currently, only one certificate ID can be specified in certificate_ids.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificates/detach
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. |
domain_id | Yes | String | Domain 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 |
---|---|---|---|
certificate_ids | Yes | Array of strings | Certificate IDs. |
verified_client_certificate_enabled | No | Boolean | Whether to enable client certificate verification. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. |
Response Parameters
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
Unbinding a domain name's SSL certificates
{"certificate_ids" : [ "a27be832f2e9441c8127fe48e3b5ac67" ]}
Example Responses
Status code: 400
Bad Request
{"error_code" : "APIG.2012","error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation"}
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.3020","error_msg" : "The URL domain does not exist"}
Status code: 500
Internal Server Error
{"error_code" : "APIG.9999","error_msg" : "System error"}
Status Codes
Status Code | Description |
---|---|
204 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes
See Error Codes.
- Calling Method
- URI