检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍特殊流控的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选
设置特殊流控 对象模型 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 共享版API(仅存量用户使用)
Integer 特殊对象在流控时间内能够调用API的最大次数限制 请求消息样例: { "call_limits": 180 } 响应消息 表4 参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String 流控策略编号 instance_id
该指标用于统计测量api接口请求流量 ≥0 单位:Byte/KB/MB/GB 测量对象:单个API 测量维度:api_id 1分钟 output_throughput 流出流量 该指标用于统计测量api接口返回流量 ≥0 单位:Byte/KB/MB/GB 测量对象:单个API 测量维度:api_id 1分钟 node_system_load
专享版-API绑定流控策略 绑定流控策略 解除API与流控策略的绑定关系 查看流控策略绑定的API列表 查看流控策略未绑定的API列表 查看API绑定的流控策略列表 批量解绑流控策略 父主题: 专享版API(V2)
是否必选 id String 流控策略的编号 R - name String 流控策略的名称 CRU 是 project_id String 流控策略创建者的租户编号 - - api_call_limits Integer 单个API流控时间内能够被访问的最大次数 CRU 是 user_call_limits
throttle_id String 流控策略的ID CR 是 front_api_id String API的编号 CR 是 env_id String 绑定的环境编号 CR 是 create_time Timestamp 绑定时间 R - 父主题: API绑定流控策略
String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制 请求消息样例: { "call_limits":
是否必选 id String 流控策略的编号 R - name String 流控策略的名称 CRU 是 project_id String 流控策略创建者的租户编号 - - api_call_limits Integer 单个API流控时间内能够被访问的最大次数 CRU 是 user_call_limits
strategy_id 是 String 流控策略的编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 instance_type 否 String 特殊流控类型: APP,USER app_name 否
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
数,支持基础流控、参数流控和基于基础流控的特殊流控。 基础流控:可以对API、用户、凭据、源IP进行多维度流控,与已有的流量控制策略说明功能一致,但配置方式不兼容。 参数流控:支持根据Header、Path、Method、Query以及系统变量中的参数值进行自定义流控。 基于基础
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance
说明 api-limit 是 Number API访问次数限制 user-limit 否 Number 用户访问次数限制 app-limit 否 Number 应用访问次数限制 ip-limit 否 Number 源IP访问次数限制 interval 是 Number 流控策略时间周期
1:独享,表示绑定到流控策略的单个API流控时间内能够被调用多少次 2:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次 enable_adaptive_control 否 String 是否开启动态流控: TRUE FALSE 暂不支持 请求消息样例: { "api_call_limits":
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
Integer 符合条件的流控策略的数量 size Integer 本次返回的列表长度 throttles 字典数据类型 本次查询到的流控策略列表 表4 throttles参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。
1:独享,表示绑定到流控策略的单个API流控时间内能够被调用多少次 2:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次 enable_adaptive_control 否 String 是否开启动态流控: TRUE FALSE 暂不支持 请求消息样例: { "api_call_limits":
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略