查看API绑定的流控策略列表
功能介绍
查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-throttles
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
api_id |
是 |
String |
API编号 |
|
throttle_id |
否 |
String |
流控策略的编号 |
|
throttle_name |
否 |
String |
流控策略的名称 |
|
env_id |
否 |
String |
绑定的环境编号 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
throttles |
Array of ThrottleForApi objects |
本次查询返回的流控策略列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
app_call_limits |
Integer |
APP流量限制是指一个API在时长之内被每个APP访问的次数上限，该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 |
|
name |
String |
流控策略名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。
说明：
中文字符必须为UTF-8或者unicode编码。 |
|
time_unit |
String |
流控的时间单位 |
|
remark |
String |
流控策略描述字符长度不超过255。
说明：
中文字符必须为UTF-8或者unicode编码。 |
|
api_call_limits |
Integer |
API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制，系统默认配额为200tps，用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 |
|
type |
Integer |
流控策略的类型
|
|
enable_adaptive_control |
String |
是否开启动态流控：
暂不支持 |
|
user_call_limits |
Integer |
用户流量限制是指一个API在时长之内每一个用户能访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 |
|
time_interval |
Integer |
流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 |
|
ip_call_limits |
Integer |
源IP流量限制是指一个API在时长之内被每个IP访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 |
|
id |
String |
流控策略的ID |
|
bind_num |
Integer |
流控绑定的API数量 |
|
is_inclu_special_throttle |
Integer |
是否包含特殊流控配置
|
|
create_time |
String |
创建时间 |
|
env_name |
String |
流控策略生效的环境（即在哪个环境上有效） |
|
bind_id |
String |
流控策略与API绑定关系编号 |
|
bind_time |
String |
流控策略与API绑定时间 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"total" : 1,
"size" : 1,
"throttles" : [ {
"id" : "3437448ad06f4e0c91a224183116e965",
"name" : "throttle_demo",
"api_call_limits" : 800,
"user_call_limits" : 500,
"app_call_limits" : 300,
"ip_call_limits" : 600,
"time_interval" : 1,
"time_unit" : "SECOND",
"create_time" : "2020-07-31T08:44:02Z",
"remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
"is_inclu_special_throttle" : 2,
"env_name" : "RELEASE",
"type" : 1,
"bind_id" : "3e06ac135e18477e918060d3c59d6f6a",
"bind_time" : "2020-08-03T12:25:52Z",
"bind_num" : 0,
"enable_adaptive_control" : "FALSE"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:throttle_name. Please refer to the support documentation"
}
状态码： 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码： 404
Not Found
{
"error_code" : "APIG.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
