Querying Plug-ins Bound to an API¶

Function¶

This API is used to query the plug-ins bound to an API.

Query plug-ins bound to a specified API
Pagination query
Fuzzy query by plug-in name

Calling Method¶

For details, see Calling APIs.

URI¶

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attached-plugins

**Table 1** Path Parameters¶
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.
api_id	Yes	String	API ID.

**Table 2** Query Parameters¶
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.
plugin_name	No	String	Plug-in name.
plugin_id	No	String	Plug-in ID.
env_name	No	String	Environment name.
plugin_type	No	String	Plug-in type.

Request Parameters¶

**Table 3** Request header 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

**Table 4** Response body parameters¶
Parameter	Type	Description
size	Integer	Length of the returned resource list.
total	Long	Number of resources that match the query conditions.
plugins	Array of AttachedPluginInfo objects	Plug-ins bound to the API.

**Table 5** AttachedPluginInfo¶
Parameter	Type	Description
plugin_attach_id	String	Plug-in binding record ID.
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. cors: Cross-origin resource sharing. set_resp_headers: HTTP response header management. kafka_log: Kafka log push. breaker: Circuit breaker. rate_limit: Request throttling. third_auth: Third-party authentication. Enumeration values: cors set_resp_headers kafka_log breaker rate_limit third_auth
plugin_scope	String	Plug-in scope. global: Visible to all gateways. Enumeration values: global
env_id	String	ID of the environment for binding to the API.
env_name	String	Name of the environment for binding to the API.
attached_time	String	Binding time.
plugin_content	String	Plug-in content in JSON format. 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

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 10** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests¶

None

Example Responses¶

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "plugins" : [ {
    "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
    "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",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "attached_time" : "2022-11-02T12:31:23.353Z",
    "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: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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 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.

last updated: 2024-12-13 16:21 UTC - commit: 9ff5103dad551eb3fcc6439582ab3ab13e6670f5