查询流控策略列表
功能介绍
查询所有流控策略的信息。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
|
请求方法 |
URI |
|---|---|
|
GET |
/v1/{project_id}/apigw/instances/{instance_id}/throttles[?page_size, page_no, id, name] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值：id、name、page_size、page_no。
请求消息
|
名称 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 |
|
instance_id |
是 |
String |
实例ID，可从API网关控制台的专享版实例信息中获取。 |
|
id |
否 |
String |
流控策略编号 |
|
name |
否 |
String |
流控策略名称 |
|
page_size |
否 |
Integer |
每页显示的条数，默认值：20 |
|
page_no |
否 |
Integer |
页码，默认值：1 |
|
precise_search |
否 |
String |
指定需要精确匹配查找的参数名称，目前仅支持name |
响应消息
|
名称 |
类型 |
说明 |
|---|---|---|
|
total |
Integer |
符合条件的流控策略的数量 |
|
size |
Integer |
本次返回的列表长度 |
|
throttles |
字典数据类型 |
本次查询到的流控策略列表 |
|
参数 |
类型 |
说明 |
|---|---|---|
|
id |
String |
流控策略的ID |
|
name |
String |
流控策略的名称 |
|
api_call_limits |
Integer |
单个API流控时间内能够被访问的次数限制 |
|
user_call_limits |
Integer |
单个用户流控时间内能够访问API的次数限制 |
|
app_call_limits |
Integer |
单个APP流控时间内能够访问API的次数限制 |
|
ip_call_limits |
Integer |
单个IP流控时间内能够访问API的次数限制 |
|
time_interval |
Integer |
流控的时长 |
|
time_unit |
String |
流控的时间单位 |
|
remark |
String |
描述 |
|
create_time |
Timestamp |
创建时间 |
|
is_include_special_throttle |
Integer |
是否包含特殊流控配置：
|
|
type |
Integer |
流控策略的类型，取值如下：
|
|
bind_num |
Integer |
流控绑定的API数量 |
|
enable_adaptive_control |
String |
是否开启动态流控：
暂不支持 |
{
"total": 2,
"size": 2,
"throttles": [{
"id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
"name": "每秒500次",
"api_call_limits": 500,
"user_call_limits": 200,
"app_call_limits": 100,
"app_call_limits": 100,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T02:04:08Z",
"remark": "API每秒500次，用户200次，APP100次，IP100次",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
},
{
"id": "0325b671-2d50-4614-9868-22102262695d",
"name": "每秒1000次",
"api_call_limits": 1000,
"user_call_limits": 500,
"app_call_limits": 300,
"ip_call_limits": 600,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T01:55:59Z",
"remark": "API每秒1000次，用户500次，APP300次，IP600次",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
}]
}
状态码
|
状态码 |
说明 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
500 |
Server Internal Error |
