Querying APIs Bound with a Plug-in¶
Function¶
This API is used to query the APIs to which a plug-in has been bound.
Query APIs bound with a specified plug-in
Pagination query
Fuzzy query by API name
APIs taken offline are also included.
Calling Method¶
For details, see Calling APIs.
URI¶
GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attached-apis
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. |
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 |
env_id | No | String | Environment ID. |
api_name | No | String | API name. |
api_id | No | String | API ID. |
group_id | No | String | Group ID. |
req_method | No | String | Request method. |
req_uri | No | String | Request path. |
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. |
apis | Array of PluginApiInfo objects | APIs bound to the plug-in. |
Parameter | Type | Description |
---|---|---|
api_id | String | API ID. |
api_name | String | API name. Enter 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:() |
type | Integer | API type.
Enumeration values:
|
req_protocol | String | API request protocol.
Default: HTTPS Enumeration values:
|
req_method | String | Request method. Enumeration values:
|
req_uri | String | Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks ( Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Note The address must comply with the URI specifications. |
auth_type | String | API authentication mode.
Enumeration values:
|
match_mode | String | API matching mode.
Default value: NORMAL Enumeration values:
|
remark | String | API description. |
group_id | String | ID of the API group to which the API belongs. |
group_name | String | Name of the API group to which the API belongs. |
roma_app_id | String | Integration application ID for ROMA instances. This parameter can be left blank. |
env_id | String | ID of the environment for binding to the API. |
env_name | String | Name of the environment for binding to the API. |
publish_id | String | Publishing record ID. |
plugin_attach_id | String | Plug-in binding record ID. |
attached_time | String | Binding 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: 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¶
None
Example Responses¶
Status code: 200
OK
{
"total" : 1,
"size" : 1,
"apis" : [ {
"api_id" : "8aa097b00e9843efabc9c593d11b769d",
"api_name" : "Test_API",
"type" : 1,
"req_protocol" : "HTTP",
"req_method" : "GET",
"req_uri" : "/test",
"auth_type" : "IAM",
"match_mode" : "NORMAL",
"remark" : "API description.",
"group_id" : "b9be707660c5406394f8973e087bae20",
"group_name" : "DEFAULT",
"roma_app_id" : "",
"plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
"publish_id" : "4739b3s5b729aa2237ef0d66dc635276",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name" : "RELEASE",
"attached_time" : "2022-11-02T12:31:23.353Z"
} ]
}
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 |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.