查看特殊设置列表 - ListSpecialThrottlingConfigurationsV2
功能介绍
查看给流控策略设置的特殊配置。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/apic/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id | 是 | String | 实例ID |
throttle_id | 是 | String | 流控策略的编号 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Long | 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 |
limit | 否 | Integer | 每页显示的条目数量 |
object_type | 否 | String | 特殊流控类型：APP, USER |
app_name | 否 | String | 筛选的特殊应用名称 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
size | Integer | 本次返回的列表长度 |
total | Long | 满足条件的记录数 |
throttle_specials | Array of ThrottleSpecialInfo objects | 本次查询返回的特殊配置列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 特殊配置的编号 |
call_limits | Integer | 特殊对象在流控时间内能够访问API的最大次数限制 |
apply_time | String | 设置时间 |
app_name | String | 作用的APP名称 |
app_id | String | 作用的APP编号 |
object_id | String | 特殊对象的身份标识 |
object_type | String | 特殊对象类型
|
object_name | String | 作用的凭据或租户的名称 |
throttle_id | String | 流控策略编号 |
状态码：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,
"throttle_specials" : [ {
"call_limits" : 200,
"app_name" : "app_demo",
"object_name" : "app_demo",
"object_id" : "356de8eb7a8742168586e5daf5339965",
"throttle_id" : "3437448ad06f4e0c91a224183116e965",
"apply_time" : "2020-08-04T02:40:56Z",
"id" : "a3e9ff8db55544ed9db91d8b048770c0",
"app_id" : "356de8eb7a8742168586e5daf5339965",
"object_type" : "APP"
} ]
} 状态码：400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:app_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.3005",
"error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 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 |
错误码
请参见错误码。
