Querying Plug-ins¶
Function¶
This API is used to query details about a group of plug-ins that meet specified conditions.
Pagination query
Query by plug-in type
Query by plug-in scope
Query by plug-in ID
Fuzzy query by plug-in name
Calling Method¶
For details, see Calling APIs.
URI¶
GET /v2/{project_id}/apigw/instances/{instance_id}/plugins
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 |
---|---|---|---|
offset | No | Long | Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0 |
limit | No | Integer | Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20 |
plugin_type | No | String | Plug-in type. |
plugin_scope | No | String | Plug-in scope. |
plugin_id | No | String | Plug-in ID. |
plugin_name | No | String | Plug-in name, which can be used for fuzz query. |
precise_search | No | String | Parameter name for exact match. Plug-in name is supported. |
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: 200
Parameter | Type | Description |
---|---|---|
size | Integer | Length of the returned resource list. |
total | Long | Number of resources that match the query conditions. |
plugins | Array of PluginInfo objects | Plug-ins. |
Parameter | Type | Description |
---|---|---|
plugin_id | String | Plug-in ID. |
plugin_name | String | Plug-in name. Start with a letter, and include only letters, digits, hyphens (-), and underscores(_). (3 to 255 characters) |
plugin_type | String | Plug-in type.
Enumeration values:
|
plugin_scope | String | Plug-in scope. global: Visible to all gateways. Enumeration values:
|
plugin_content | String | Plug-in content in JSON format. For details, see the model definition.
Maximum: 65535 |
remark | String | Plug-in description, with a maximum of 255 characters. Maximum: 255 |
create_time | String | Creation time. |
update_time | String | Update time. |
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. |
Example Requests¶
None
Example Responses¶
Status code: 200
OK
{
"total" : 1,
"size" : 1,
"plugins" : [ {
"plugin_id" : "5b729aa252764739b3s237ef0d66dc63",
"plugin_name" : "CORS",
"plugin_type" : "cors",
"plugin_scope" : "global",
"plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}",
"remark" : "Cross-origin resource sharing",
"create_time" : "2022-11-02T12:31:23.353Z",
"update_time" : "2022-11-02T12:31:23.353Z"
} ]
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:plugin_name. 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: 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 |
500 | Internal Server Error |
Error Codes¶
See Error Codes.