查询用户自定义的流控策略列表及详情信息，支持条件查询。
接口说明
- 此功能面向开放 API 的用户
- 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息
- 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DescribeTrafficControls | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TrafficControlId | string | 否 | 流控策略 ID | tf123456 |
| GroupId | string | 否 | 指定的分组编号，必须和 ApiId、StageName 一起查询 | 0009db9c828549768a200320714b8930 |
| ApiId | string | 否 | 指定的 API 编号，必须和 GroupId、StageName 一起查询 | 3b81fd160f5645e097cc8855d75a1cf6 |
| StageName | string | 否 | 环境名称，必须和 GroupId、ApiId 一起查询 ，可选值：
| RELEASE |
| TrafficControlName | string | 否 | 流控策略名称 | 流控测试 |
| PageNumber | integer | 否 | 指定要查询的页码，默认是 1，起始是 1 | 1 |
| PageSize | integer | 否 | 指定分页查询时每页行数，最大值 100，默认值为 10 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
"PageSize": 10,
"TotalCount": 1,
"TrafficControls": {
"TrafficControl": [
{
"UserDefault": 15000,
"ApiDefault": 20000,
"ModifiedTime": "2016-01-27T10:34:38Z",
"Description": "test",
"TrafficControlUnit": "Minute",
"TrafficControlName": "wulingtestq1",
"AppDefault": 8000,
"TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
"CreatedTime": "2016-01-27T10:19:39Z",
"SpecialPolicies": {
"SpecialPolicy": [
{
"SpecialType": "USER",
"Specials": {
"Special": [
{
"TrafficValue": 100,
"SpecialKey": "test_wg@aliyun.com"
}
]
}
}
]
}
}
]
}
}JSON格式
{
"PageNumber": 1,
"RequestId": "93D91A99-F093-4596-87BA-3C4FBFD3FD8A",
"PageSize": 10,
"TotalCount": 1,
"TrafficControls": {
"TrafficControl": [
{
"UserDefault": 15000,
"ApiDefault": 20000,
"ModifiedTime": "2016-01-27T10:34:38Z",
"Description": "test",
"TrafficControlUnit": "Minute",
"TrafficControlName": "wulingtestq1",
"AppDefault": 8000,
"TrafficControlId": "cfed6c970d45481dbe136d6b5ac68c41",
"CreatedTime": "2016-01-27T10:19:39Z",
"SpecialPolicies": {
"SpecialPolicy": [
{
"SpecialType": "USER",
"Specials": {
"Special": [
{
"TrafficValue": 100,
"SpecialKey": "test_wg@aliyun.com"
}
]
}
}
]
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史