Deleting an API Group¶
Function¶
This API is used to delete an API group.
If the group to delete contains APIs, take the APIs offline and delete them.
All resources (independent domain names and SSL certificates) directly or indirectly associated with the group will be deleted. The operation will also unbind the external domain names from the subdomain name based on the CNAME resolution mode.
Calling Method¶
For details, see Calling APIs.
URI¶
DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}
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. |
Response Parameters¶
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: 412
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error description. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
None
Example Responses¶
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: 412
PreconditionFailed
{
"error_code" : "APIG.3415",
"error_msg" : "The API group cannot be deleted because it contains APIs,id:47eaed4659db4e99ba2e1b642d5d1323"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
204 | No Content |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
412 | PreconditionFailed |
500 | Internal Server Error |
Error Codes¶
See Error Codes.