DescribePlugins - API Gateway - Alibaba Cloud Documentation Center

Queries API Gateway plug-ins and the details of the plug-ins.

Operation description

This operation supports pagination.
This operation allows you to query plug-ins by business type.
This operation allows you to query plug-ins by ID.
This operation allows you to query plug-ins by name.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribePlugins	get	Plugin `acs:apigateway:{#regionId}:{#accountId}:plugin/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PluginId	string	No	The ID of the plug-in.	a96926e82f994915a8da40a119374537
PluginType	string	No	The business type of the plug-in.	cors
PluginName	string	No	The name of the plug-in.	testPlugin
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
Tag	array<object>	No	The tag of objects that match the lifecycle rule. You can specify multiple tags.	Key， Value
	object	No
Key	string	No	The key of the tag. N can be an integer from 1 to 20.``	env
Value	string	No	The value of the tag. N can be an integer from 1 to 20.``	' '

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	46373DC4-19F1-4DC8-8C31-1107289BB5E0
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	1
Plugins	array<object>	The returned information about the plug-in. It is an array consisting of PluginAttribute data.
PluginAttribute	object
PluginId	string	The ID of the plug-in.	9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTime	string	The last modification time (UTC) of the plug-in.	2019-01-11T09:29:58Z
PluginData	string	The definition statement of the plug-in.	{"unit":"MINUTE","apiDefault":20}
Description	string	The plug-in description.	Throttling
PluginName	string	The name of the plug-in.	firstPlugin
CreatedTime	string	The creation time (UTC) of the plug-in.	2019-01-11T09:29:58Z
PluginType	string	The type of the plug-in.	trafficControl
RegionId	string	The region where the plug-in is located.	cn-qingdao
Tags	array<object>	The tags.
TagInfo	object
Key	string	The key of the tag.	testkey
Value	string	The value of the tag.	tetstvalue

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0",
  "PageSize": 10,
  "TotalCount": 1,
  "Plugins": {
    "PluginAttribute": [
      {
        "PluginId": "9a3f1a5279434f2ba74ccd91c295af9f",
        "ModifiedTime": "2019-01-11T09:29:58Z",
        "PluginData": {
          "unit": "MINUTE",
          "apiDefault": 20
        },
        "Description": "Throttling\n",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao",
        "Tags": {
          "TagInfo": [
            {
              "Key": "testkey",
              "Value": "tetstvalue"
            }
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details
2021-12-31	The response structure of the API has changed	View Change Details