API网关 APIG-创建流控策略:请求消息

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

请求消息

表3 参数说明

参数

是否必选

类型

说明

name

String

流控策略名称。

支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。

说明:

中文字符必须为UTF-8或者unicode编码。

api_call_limits

Integer

API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。

user_call_limits

Integer

用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。

app_call_limits

Integer

APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。

ip_call_limits

Integer

源IP流量限制是指一个API在时长之内被每个IP访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。

time_interval

Integer

流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。

time_unit

String

流控的时间单位:

  • SECOND
  • MINUTE
  • HOUR
  • DAY

remark

String

流控策略描述

字符长度不超过255。

说明:

中文字符必须为UTF-8或者unicode编码。

type

Integer

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

  • 1:独享,表示绑定到流控策略的单个API流控时间内能够被调用多少次。
  • 2:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次。

enable_adaptive_control

String

是否开启动态流控:

  • TRUE
  • FALSE

暂不支持

请求消息样例:

{"api_call_limits": 800,"user_call_limits": 500,"app_call_limits": 300,        "ip_call_limits": 600,"name": "每秒800次","remark": "API每秒800次,用户500次,APP300次,IP600次","time_interval": 1,"time_unit": "SECOND"}
support.huaweicloud.com/api-apig/apig-phapi-180713064.html