Retrieve API Group Plugins with DescribePluginsByGroup - API Gateway - Alibaba Cloud - API Gateway

Query Plugins Bound to API Group

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	Group ID	08ae4aa0f95e4321849ee57f4e0b3077
StageName	string	Yes	Specifies the environment of the API to operate on. RELEASE: Production PRE: Pre-release TEST: Test	RELEASE
PageNumber	integer	No	Pagination parameter: current page number	1
PageSize	integer	No	Pagination parameter: number of items per page.	10

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	Pagination parameter: current page number	1
RequestId	string	Request ID	5F5574BA-F22B-563D-841E-C817964F517F
PageSize	integer	Pagination parameter: number of items per page.	10
TotalCount	integer	Total number of results returned	32
Plugins	object
PluginAttribute	array<object>	Returns information about the plugins
	object
PluginId	string	Plugin ID	5e204eeb4aa94c919a49f471ad3fc716
ModifiedTime	string	Last modified time, in GMT	2022-03-15T02:30:18Z
PluginData	string	Plugin definition statement	{\"unit\":\"MINUTE\",\"apiDefault\":20}
Description	string	Plugin description	Throttling
PluginName	string	Plugin name	firstPlugin
CreatedTime	string	Creation time, in GMT	2024-12-20T02:05:57Z
PluginType	string	Plugin type	trafficControl
RegionId	string	Where the plug-in resides Region	cn-hangzhou

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "5F5574BA-F22B-563D-841E-C817964F517F",
  "PageSize": 10,
  "TotalCount": 32,
  "Plugins": {
    "PluginAttribute": [
      {
        "PluginId": "5e204eeb4aa94c919a49f471ad3fc716",
        "ModifiedTime": "2022-03-15T02:30:18Z",
        "PluginData": "{\\\"unit\\\":\\\"MINUTE\\\",\\\"apiDefault\\\":20}",
        "Description": "Throttling",
        "PluginName": "firstPlugin",
        "CreatedTime": "2024-12-20T02:05:57Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.