调用DescribeTrafficControls查询用户自定义的流控策略列表及详情信息,支持条件查询。
- 此功能面向开放API的用户
- 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略,包括详细信息
- 此接口还可以支持条件查询,如查询指定接口所绑定的流控策略,如查询指定环境下的流控策略
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeTrafficControls |
操作接口名,系统规定参数,取值:DescribeTrafficControls。 |
ApiId | String | 否 | 3b81fd160f5645e097cc8855d75a1cf6 |
指定的API编号,必须和GroupId、StageName一起查询 |
GroupId | String | 否 | 0009db9c828549768a200320714b8930 |
指定的分组编号,必须和ApiId、StageName一起查询 |
PageNumber | Integer | 否 | 1 |
指定要查询的页码,默认是1,起始是1 |
PageSize | Integer | 否 | 10 |
指定分页查询时每页行数,最大值100,默认值为10 |
StageName | String | 否 | RELEASE |
环境名称,必须和GroupId、ApiId一起查询 ,可选值:
|
TrafficControlId | String | 否 | tf123456 |
流控策略ID |
TrafficControlName | String | 否 | 流控测试 |
流控策略名称 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
返回指定的页码 |
PageSize | Integer | 10 |
返回指定的每页条数 |
RequestId | String | 93D91A99-F093-4596-87BA-3C4FBFD3FD8A |
请求ID |
TotalCount | Integer | 1 |
返回结果的总条数 |
TrafficControls | Array |
由 TrafficControl 组成的数组格式,返回流控策略信息 |
|
TrafficControl |
由 TrafficControl 组成的数组格式,返回流控策略信息 |
||
ApiDefault | Integer | 20000 |
每个API默认流控值 |
AppDefault | Integer | 8000 |
每个app默认的流控值 |
CreatedTime | String | 2016-01-27T10:19:39Z |
创建时间(格林威治时间) |
Description | String | test |
流控策略描述 |
ModifiedTime | String | 2016-01-27T10:34:38Z |
上一次修改时间(格林威治时间) |
SpecialPolicies | Array |
由 SpecialPolicy 组成的数组格式,返回特殊流控策略信息 |
|
SpecialPolicy |
由 SpecialPolicy 组成的数组格式,返回特殊流控策略信息 |
||
SpecialType | String | USER |
特殊流控类型,可选值:
|
Specials | Array |
由 Special 组成的数组格式,返回特殊流控策略数据项信息 |
|
Special |
由 Special 组成的数组格式,返回特殊流控策略数据项信息 |
||
SpecialKey | String | test_wg@aliyun.com |
根据SpecialType对应的AppId或者是用户账号 |
TrafficValue | Integer | 100 |
流控值 |
TrafficControlId | String | cfed6c970d45481dbe136d6b5ac68c41 |
流控策略ID |
TrafficControlName | String | wulingtestq1 |
流控策略名称 |
TrafficControlUnit | String | Minute |
流控策略单位,可选值:
|
UserDefault | Integer | 15000 |
每个用户默认的流控值 |
示例
请求示例
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControls
&TrafficControlId=tf123456
&TrafficControlName=流控测试
&GroupId=0009db9c828549768a200320714b8930
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=RELEASE
&<公共请求参数>
正常返回示例
XML
格式
<DescribeTrafficControlsResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<RequestId>93D91A99-F093-4596-87BA-3C4FBFD3FD8A</RequestId>
<TrafficControls>
<TrafficControl>
<TrafficControlId>cfed6c970d45481dbe136d6b5ac68c41</TrafficControlId>
<ApiDefault>20000</ApiDefault>
<TrafficControlUnit>Minute</TrafficControlUnit>
<TrafficControlName>wulingtestq1</TrafficControlName>
<ModifiedTime>2016-01-27T10:34:38Z</ModifiedTime>
<UserDefault>15000</UserDefault>
<AppDefault>8000</AppDefault>
<Description>test</Description>
<CreateTime>2016-01-27T10:19:39Z</CreateTime>
<SpecialPolicies>
<SpecialPolicy>
<SpecialType>User</SpecialType>
<Specials>
<Special>
<TrafficValue>100</TrafficValue>
<SpecialKey>test_wg@aliyun.com</SpecialKey>
</Special>
</Specials>
</SpecialPolicy>
<SpecialPolicy>
<SpecialType>App</SpecialType>
<Specials>
<Special>
<TrafficValue>100</TrafficValue>
<SpecialKey>12345678</SpecialKey>
</Special>
</Specials>
</SpecialPolicy>
</SpecialPolicies>
</TrafficControl>
</TrafficControls>
</DescribeTrafficControlsResponse>
JSON
格式
{
"PageNumber":1,
"TotalCount":1,
"PageSize":10,
"RequestId":"93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
"TrafficControls":{
"TrafficControl":[
{
"SpecialPolicies":{
"SpecialPolicy":[
{
"Specials":{
"Special":[
{
"TrafficValue":100,
"SpecialKey":"test_wg@aliyun.com"
}
]
},
"SpecialType":"User"
},
{
"Specials":{
"Special":[
{
"TrafficValue":100,
"SpecialKey":"12345678"
}
]
},
"SpecialType":"App"
}
]
},
"Description":"test",
"TrafficControlUnit":"Minute",
"CreateTime":"2016-01-27T10:19:39Z",
"ApiDefault":20000,
"ModifiedTime":"2016-01-27T10:34:38Z",
"TrafficControlName":"wulingtestq1",
"TrafficControlId":"cfed6c970d45481dbe136d6b5ac68c41",
"UserDefault":15000,
"AppDefault":8000
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交