This API is used to unbind request throttling policies from APIs.
PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-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. |
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 |
|---|---|---|---|
throttle_bindings |
No |
Array of strings |
IDs of the request throttling policy binding records to be canceled. |
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
success_count |
Integer |
Number of request throttling policies that have been successfully unbound. |
failure |
Array of ThrottleBindingBatchFailure objects |
Error message and request throttling policies that fail to be unbound. |
Parameter |
Type |
Description |
|---|---|---|
bind_id |
String |
ID of a request throttling 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: 500
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Unbinding request throttling policies from APIs
{
"throttle_bindings" : [ "6a6a75b425df416cbdcd7821da30be8d", "b11e5970f732440dbea647580647d57f" ]
}
Status code: 200
OK
{
"failure" : [ {
"bind_id" : "b11e5970f732440dbea647580647d57f",
"error_code" : "APIG.3012",
"error_msg" : "The request throttling policy binding record does not exist"
} ],
"success_count" : 1
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "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: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Code |
Description |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal Server Error |
See Error Codes.