查询API上绑定的插件_插件管理相关接口_API 参考_开发指南_API 网关

描述

查询指定环境指定API上绑定的一组插件，该API在该环境必须是运行中状态

此功能面向开放API的用户
用于查询指定环境上指定API已绑定的插件
支持分页

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：DescribePluginsByApi
ApiId	String	是	指定要查询的Api编号
GroupId	String	是	指定要查询的API所属分组ID
StageName	String	是	指定要查询的环境 RELEASE: 线上 PRE: 预发 TEST: 测试
PageNumber	Integer	否	指定要查询的页码，默认是1，起始是1
PageSize	Integer	否	指定分页查询时每页行数，最大值100，默认值为10

返回参数

名称	类型	描述
RequestId	String	本次请求编号
TotalCount	Integer	返回结果的总条数
PageNumber	Integer	返回指定的页码
PageSize	Integer	返回指定的每页条数
Plugins	PluginAttribute	由PluginAttribute组成的数组格式，返回插件的信息项

示例

请求示例

http://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribePluginsByApi
 &ApiId=93f4ead4080c4b2da70b7f81f50ae459
 &GroupId=3c7a38392e764718ad7673e7b7f535d4
 &StageName=RELEASE
 &<公共请求参数>

返回示例

XML格式

<DescribePluginsByApiResponse>
   <RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>
   <TotalCount>20</TotalCount>
   <PageSize>10</PageSize>
   <PageNumber>1</PageNumber>
   <Plugins>
      <PluginAttribute>
          <PluginId>9a3f1a5279434f2ba74ccd91c295af9f</PluginId>
          <PluginName>firstPlugin</PluginName>
          <RegionId>cn-qingdao</RegionId>
          <PluginType>trafficControl</PluginType>
          <PluginData>{"unit":"MINUTE","apiDefault":20}</PluginData>
          <Description>流控</Description>
          <CreatedTime>2019-01-11T09:29:58Z</CreatedTime>
          <ModifiedTime>2019-01-11T09:29:58Z</ModifiedTime>
      </PluginAttribute>
   </Plugins>
</DescribePluginsByApiResponse>

JSON格式

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