全部产品
云市场

查询流控策略列表

更新时间:2018-08-08 14:59:12

条件查询流控策略列表及详情信息(DescribeTrafficControls)

描述

查询用户自定义的流控策略列表及详情信息,支持条件查询

  • 此功能面向开放API的用户
  • 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略,包括详细信息
  • 此接口还可以支持条件查询,如查询指定接口所绑定的流控策略,如查询指定环境下的流控策略

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeTrafficControls
TrafficControlId String 流控策略ID
GroupId String 指定的分组编号,必须和ApiId、StageName一起查询
ApiId String 指定的API编号,必须和GroupId、StageName一起查询
StageName String 环境名称,必须和GroupId、ApiId一起查询 ,可选值:
  • RELEASE:线上
  • TEST:测试
TrafficControlName String 流控策略名称
PageSize Integer 指定分页查询时每页行数,最大值100,默认值为10
PageNumber Integer 指定要查询的页码,默认是1,起始是1

返回参数

名称 类型 描述
RequestId String 本次请求编号
TotalCount Integer 返回结果的总条数
PageNumber Integer 返回指定的页码
PageSize Integer 返回指定的每页条数
TrafficControls TrafficControl 由 TrafficControl 组成的数组格式,返回流控策略信息

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControls
  2. &TrafficControlId=tf123456
  3. &TrafficControlName=流控测试
  4. &GroupId=0009db9c828549768a200320714b8930
  5. &ApiId=3b81fd160f5645e097cc8855d75a1cf6
  6. &StageName=RELEASE
  7. &<公共请求参数>

返回示例

XML格式

  1. <DescribeTrafficControlsResponse>
  2. <TotalCount>1</TotalCount>
  3. <PageSize>10</PageSize>
  4. <PageNumber>1</PageNumber>
  5. <RequestId>93D91A99-F093-4596-87BA-3C4FBFD3FD8A</RequestId>
  6. <TrafficControls>
  7. <TrafficControl>
  8. <TrafficControlId>cfed6c970d45481dbe136d6b5ac68c41</TrafficControlId>
  9. <ApiDefault>20000</ApiDefault>
  10. <TrafficControlUnit>Minute</TrafficControlUnit>
  11. <TrafficControlName>wulingtestq1</TrafficControlName>
  12. <ModifiedTime>2016-01-27T10:34:38Z</ModifiedTime>
  13. <UserDefault>15000</UserDefault>
  14. <AppDefault>8000</AppDefault>
  15. <Description>test</Description>
  16. <CreateTime>2016-01-27T10:19:39Z</CreateTime>
  17. <SpecialPolicies>
  18. <SpecialPolicy>
  19. <SpecialType>User</SpecialType>
  20. <Specials>
  21. <Special>
  22. <TrafficValue>100</TrafficValue>
  23. <SpecialKey>test_wg@aliyun.com</SpecialKey>
  24. </Special>
  25. </Specials>
  26. </SpecialPolicy>
  27. <SpecialPolicy>
  28. <SpecialType>App</SpecialType>
  29. <Specials>
  30. <Special>
  31. <TrafficValue>100</TrafficValue>
  32. <SpecialKey>12345678</SpecialKey>
  33. </Special>
  34. </Specials>
  35. </SpecialPolicy>
  36. </SpecialPolicies>
  37. </TrafficControl>
  38. </TrafficControls>
  39. </DescribeTrafficControlsResponse>

JSON格式

  1. {
  2. "TotalCount": 1,
  3. "PageSize": 10,
  4. "PageNumber": 1,
  5. "RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
  6. "TrafficControls": {
  7. "TrafficControl": [
  8. {
  9. "TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
  10. "ApiDefault": 20000,
  11. "TrafficControlUnit": "Minute",
  12. "TrafficControlName": "wulingtestq1",
  13. "ModifiedTime": "2016-01-27T10:34:38Z",
  14. "UserDefault": 15000,
  15. "AppDefault": 8000,
  16. "Description": "test",
  17. "CreateTime": "2016-01-27T10:19:39Z",
  18. "SpecialPolicies": {
  19. "SpecialPolicy": [
  20. {
  21. "SpecialType": "User",
  22. "Specials": {
  23. "Special": [
  24. {
  25. "TrafficValue": 100,
  26. "SpecialKey": "test_wg@aliyun.com"
  27. }
  28. ]
  29. }
  30. },
  31. {
  32. "SpecialType": "App",
  33. "Specials": {
  34. "Special": [
  35. {
  36. "TrafficValue": 100,
  37. "SpecialKey": "12345678"
  38. }
  39. ]
  40. }
  41. }
  42. ]
  43. }
  44. }
  45. ]
  46. }
  47. }