Unbinding Access Control Policies¶
Function¶
This API is used to unbind multiple access control policies from APIs.
URI¶
PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings
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. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
action | Yes | String | The value must be delete. |
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 |
---|---|---|---|
acl_bindings | No | Array of strings | IDs of the access control policy binding records to be canceled. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
success_count | Integer | Number of access control policies that have been successfully unbound. |
failure | Array of AclBindingBatchFailure objects | Error message and access control policies that fail to be unbound. |
Parameter | Type | Description |
---|---|---|
bind_id | String | ID of an access control policy binding record that fails to be canceled. |
error_code | String | Error code. |
error_msg | String | Error message. |
api_id | String | ID of an API from which unbinding fails. |
api_name | String | Name of the API from which unbinding fails. |
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 multiple access control policies from APIs
{
"acl_bindings" : [ "332c5db1458a477b89b2ea741fec94a3" ]
}
Example Responses¶
Status code: 200
OK
{
"failure" : [ {
"bind_id" : "3a68d39f115d4c128fccd6f624ea6109",
"error_code" : "APIG.3010",
"error_msg" : "The access control policy binding record does not exist"
} ],
"success_count" : 1
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value: parameter action should be \\\"delete\\\""
}
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.3030",
"error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.