DescribePluginGroups API Reference for Plugin-Bound Groups - API Gateway

Query the list of groups bound to a plugin based on the plugin ID

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

get

*Plugin

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

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 elements

Element	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	object
GroupPluginSummary	array<object>	Collection of group information
	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.