DescribePluginsByApi Overview: API Plugin Binding Reference - API Gateway - Alibaba Cloud - API Gateway

Operation description

This operation is intended for API callers.
This operation supports pagination.

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:DescribePluginsByApi

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group to which the API belongs.	3c7a38392e764718ad7673e7b7f535d4
ApiId	string	Yes	The ID of the API.	93f4ead4080c4b2da70b7f81f50ae459
StageName	string	Yes	The environment in which the API is running. Valid values: RELEASE: production PRE: staging TEST: test	RELEASE
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 returned per page.	10

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 plug-in information. The information is an array that consists of PluginAttribute data.
	object
PluginId	string	The plug-in ID.	9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTime	string	The time when the plug-in was last modified. The time is displayed in UTC.	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 plug-in name.	firstPlugin
CreatedTime	string	The time when the plug-in was created. The time is displayed in UTC.	2019-01-11T09:29:58Z
PluginType	string	The plug-in type.	trafficControl
RegionId	string	The region where the plug-in resides.	cn-qingdao

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": "Throttling",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.