查看特殊设置列表
功能介绍
查看给流控策略设置的特殊配置。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
|
请求方法 |
URI |
|---|---|
|
GET |
/v1.0/apigw/throttle-specials/{strategy_id}[?page_size, page_no, instance_type, app_name, user] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:strategy_id、app_name、user、 page_size、page_no。
URI中的参数说明如下表所示。
|
名称 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
strategy_id |
是 |
String |
流控策略的编号 |
|
page_size |
否 |
Integer |
每页显示的条数,默认值:20 |
|
page_no |
否 |
Integer |
页码,默认值:1 |
|
instance_type |
否 |
String |
特殊流控类型: APP,USER |
|
app_name |
否 |
String |
筛选的特殊应用名称 |
|
user |
否 |
String |
筛选的特殊租户的账号ID |
请求消息
无
响应消息
|
名称 |
类型 |
说明 |
|---|---|---|
|
throttle_specials |
字典数据类型 |
本次查询返回的特殊配置列表 |
|
total |
Integer |
符合条件的特殊设置总数 |
|
size |
Integer |
本次查询返回的列表长度 |
|
参数 |
类型 |
说明 |
|---|---|---|
|
id |
String |
特殊配置的编号 |
|
strategy_id |
String |
流控策略编号 |
|
instance_id |
Integer |
特殊对象的身份标识 |
|
instance_name |
String |
作用的APP或租户的名称 |
|
instance_type |
Integer |
特殊对象的类型 |
|
call_limits |
Integer |
特殊对象在流控时间内能够访问API的最大次数限制 |
|
apply_time |
Timestamp |
设置时间 |
|
app_id |
String |
作用的APP编号 |
|
app_name |
String |
作用的APP名称 |
响应消息样例:
{
"total": 1,
"size": 1,
"throttle_specials": [{
"id": "778879b8-df10-495b-a087-874859fdea6d",
"strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
"instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"instance_name": "app_002",
"instance_type": "APP",
"call_limits": 180,
"apply_time": "2017-12-29T03:11:18Z",
"app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"app_name": "app_002"
}]
}
状态码
|
状态码 |
说明 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Server Internal Error |