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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribePlugins

get

*Plugin

acs:apigateway:{#regionId}:{#accountId}:plugin/*

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 elements

Element	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	object
PluginAttribute	array<object>	The returned information about the plug-in. It is an array consisting of PluginAttribute data.
	array<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.	流控
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	object
TagInfo	array<object>	The tags.
	object
Key	string	The key of the tag.	testkey
Value	string	The value of the tag.	tetstvalue

Examples

Success response

JSON format

{
  "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": "流控",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao",
        "Tags": {
          "TagInfo": [
            {
              "Key": "testkey",
              "Value": "tetstvalue"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.