DescribePluginsByGroup - API Gateway - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query Plugins Bound to API Group

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:DescribePluginsByGroup	get	All Resources ``	none	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 parameters

Parameter	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	array<object>	Returns information about the plugins
PluginAttribute	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	traffic controll
PluginName	string	Plugin name	firstPlugin
CreatedTime	string	Creation time, in GMT	2024-12-20T02:05:57Z
PluginType	string	Plugin type	trafficControl

Examples

Sample success responses

JSONformat

{
  "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": "traffic controll",
        "PluginName": "firstPlugin",
        "CreatedTime": "2024-12-20T02:05:57Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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