DescribePluginGroups - 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 the list of groups bound to a plugin based on the plugin ID

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:DescribePluginGroups	get	*Plugin `acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PluginId	string	Yes	API Gateway plugin ID	1f3bde29b43d4d53989248327ff737f2
GroupId	string	No	API group ID	8cc2a3cbe3394524b6e71be5db9b02a3
GroupName	string	No	API group name	crm_custom_service
Description	string	No	API group description	test
PageSize	integer	No	Pagination parameter: number of items per page	10
PageNumber	integer	No	Pagination parameter: current page number	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	Pagination parameter: current page number	1
RequestId	string	Request ID	765BC99E-F583-5A80-9A42-42AC125C2CDC
PageSize	integer	Pagination parameter: number of items per page, default value 10	10
TotalCount	integer	Total number of returned results	20
GroupSummarys	array<object>	Collection of group information
GroupPluginSummary	object
Description	string	Description	test
GroupName	string	API group name	ECP_API
GroupId	string	API group ID	4ed31575e2de43de8c51eb1217a1f56b
BasePath	string	API root path	/rpew
StageName	string	Environment name, possible values: RELEASE: Production PRE: Pre-release TEST: Testing	RELEASE
RegionId	string	Region ID where the API group is located	cn-beijing
StageAlias	string	Stage name Alias	DEV

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "765BC99E-F583-5A80-9A42-42AC125C2CDC",
  "PageSize": 10,
  "TotalCount": 20,
  "GroupSummarys": {
    "GroupPluginSummary": [
      {
        "Description": "test",
        "GroupName": "ECP_API",
        "GroupId": "4ed31575e2de43de8c51eb1217a1f56b",
        "BasePath": "/rpew",
        "StageName": "RELEASE",
        "RegionId": "cn-beijing",
        "StageAlias": "DEV"
      }
    ]
  }
}

Error codes

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