API网关 APIG-查询流控策略列表:响应消息

时间:2023-11-01 16:18:59

响应消息

表3 参数说明

名称

类型

说明

total

Integer

符合条件的流控策略的数量

size

Integer

本次返回的列表长度

throttles

字典数据类型

本次查询到的流控策略列表

表4 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

是否包含特殊流控配置:

  • 1:包含
  • 2:不包含

type

Integer

流控策略的类型,取值如下:

  • 1 独享
  • 2 共享

bind_num

Integer

流控绑定的API数量

enable_adaptive_control

String

是否开启动态流控:

  • TRUE
  • FALSE

暂不支持

响应消息样例:
{"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"}]}
support.huaweicloud.com/api-apig/apig-phapi-180713068.html