创建特殊设置
功能介绍
流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。
如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
为流控策略添加一个特殊设置的对象,可以是APP,也可以是租户。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
| 请求方法 | URI |
|---|---|
| POST | /v1.0/apigw/throttle-specials |
请求消息
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| call_limits | 是 | Integer | 流控时间内特殊对象能够访问API的最大次数限制 |
| instance_id | 是 | String | 特殊APP的编号或特殊租户的账号ID |
| instance_type | 是 | String | 对象类型:APP/USER |
| strategy_id | 是 | String | 流控策略编号 |
请求消息样例:
{
"call_limits": 150,
"instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"instance_type": "APP",
"strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9"
} 响应消息
| 参数 | 类型 | 说明 |
|---|---|---|
| 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名称 |
响应消息样例:
{
"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": 150,
"apply_time": "2017-12-29T03: 11: 18.2698381Z",
"app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"app_name": "app_002"
} 状态码
| 状态码 | 说明 |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |