使用DescribePlugins查询插件列表-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询插件列表及详情。

接口说明

支持分页
支持按照插件业务类型查询
支持按照插件 ID 查询
支持按照插件名称查询

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribePlugins

get

*Plugin

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

无

请求参数

名称	类型	必填	描述	示例值
PluginId	string	否	API 网关插件 ID	a96926e82f994915a8da40a119374537
PluginType	string	否	API 网关插件业务类型	cors
PluginName	string	否	API 网关插件名称	testPlugin
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。
	object	否
Key	string	否	标签键。 n 的取值范围为 `[1, 20]`	env
Value	string	否	标签值。 n 的取值范围为 `[1, 20]`	' '

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	46373DC4-19F1-4DC8-8C31-1107289BB5E0
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	1
Plugins	object
PluginAttribute	array<object>	由 PluginAttribute 组成的数组格式，返回插件信息
	array<object>
PluginId	string	插件 ID	9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTime	string	最后修改时间，格林威治时间	2019-01-11T09:29:58Z
PluginData	string	插件定义语句	{"unit":"MINUTE","apiDefault":20}
Description	string	插件描述	流控
PluginName	string	插件名称	firstPlugin
CreatedTime	string	创建时间，格林威治时间	2019-01-11T09:29:58Z
PluginType	string	插件类型	trafficControl
RegionId	string	插件所在 Region	cn-qingdao
Tags	object
TagInfo	array<object>	标签列表
	object
Key	string	标签键	testkey
Value	string	标签值	tetstvalue

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0",
  "PageSize": 10,
  "TotalCount": 1,
  "Plugins": {
    "PluginAttribute": [
      {
        "PluginId": "9a3f1a5279434f2ba74ccd91c295af9f",
        "ModifiedTime": "2019-01-11T09:29:58Z",
        "PluginData": "{\"unit\":\"MINUTE\",\"apiDefault\":20}",
        "Description": "流控",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao",
        "Tags": {
          "TagInfo": [
            {
              "Key": "testkey",
              "Value": "tetstvalue"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。