Unbinding a Plug-in from All APIs¶
Function¶
This API is used to unbind a plug-in from all APIs to which it has been bound.
The unbinding takes effect immediately.
Calling Method¶
For details, see Calling APIs.
URI¶
PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/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.  | 
plugin_id  | Yes  | String  | Plug-in 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  | 
|---|---|---|---|
env_id  | Yes  | String  | ID of the environment for binding to the API.  | 
api_ids  | Yes  | Array of strings  | IDs of bound APIs. Array Length: 1 - 500  | 
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 plug-in from all APIs to which it has been bound
{
  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "api_ids" : [ "8aa097b00e9843efabc9c593d11b769d" ]
}
Example Responses¶
Status code: 400
Bad Request
{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_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.3068",
  "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 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.