DescribePluginGroups - 查询插件绑定的分组列表_API 网关(API Gateway)-阿里云帮助中心

根据插件查询绑定的分组列表

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribePluginGroups	get	*Plugin `acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}`	无	无

请求参数

名称	类型	必填	描述	示例值
PluginId	string	是	API 网关插件 ID	1f3bde29b43d4d53989248327ff737f2
GroupId	string	否	API 分组 ID	8cc2a3cbe3394524b6e71be5db9b02a3
GroupName	string	否	API 分组名称	crm_custom_service
Description	string	否	API 分组描述信息	test
PageSize	integer	否	分页参数：每页显示条数	10
PageNumber	integer	否	分页参数：当前页码	1

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	分页参数：当前页码	1
RequestId	string	请求 ID	765BC99E-F583-5A80-9A42-42AC125C2CDC
PageSize	integer	分页参数：每页显示条数，默认值 10	10
TotalCount	integer	返回结果的总条数	20
GroupSummarys	array<object>	分组信息集合
GroupPluginSummary	object
Description	string	描述信息	test
GroupName	string	API 分组名称	ECP_API
GroupId	string	API 分组 ID	4ed31575e2de43de8c51eb1217a1f56b
BasePath	string	api 根路径	/rpew
StageName	string	环境名称，可选值： RELEASE：线上 PRE：预发 TEST：测试	RELEASE
RegionId	string	API 分组所在地域 ID	cn-beijing
StageAlias	string	环境别名	DEV

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。