全部产品
云市场

查询API上绑定的插件

更新时间:2019-01-21 14:29:33

描述

查询指定环境指定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组成的数组格式,返回插件的信息项

示例

请求示例

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

返回示例

XML格式

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

JSON格式

  1. {
  2. "RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0",
  3. "TotalCount": "1",
  4. "PageNumber": "1",
  5. "PageSize": "10",
  6. "Plugins": {
  7. "PluginAttribute": [{
  8. "PluginId":"9a3f1a5279434f2ba74ccd91c295af9f",
  9. "PluginName":"firstPlugin",
  10. "RegionId":"cn-qingdao",
  11. "PluginType":"trafficControl",
  12. "PluginData":"{\"unit\":\"MINUTE\",\"apiDefault\":20}",
  13. "Description": "流控"
  14. "CreatedTime":"2019-01-11T09:29:58Z",
  15. "ModifiedTime":"2019-01-11T09:29:58Z"
  16. }]
  17. },
  18. }