检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选 id String 特殊配置的编号 R - strategy_id String 流控策略编号 CR 是 instance_id String 生效的特殊对象的编号 CR
CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境,仅在mode为CONSUMER时有效,未提供时有如下默认值:
制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 ip_call_limits Integer 源IP流
持,可使用80默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该参数,则必须同时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。
函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN。 authorizer_version 否 String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN。 最大长度:64。 need_body 否 Boolean
API的请求协议 HTTP HTTPS app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 domain 否 String API的访问域名,如果使用自定义入方向端口的特性时,需要带上端口信息,用冒号分隔,例如test
参数 参数类型 描述 protocol String 实例自定义入方向端口协议。 HTTP:实例自定义入方向端口使用HTTP协议。 HTTPS:实例自定义入方向端口使用HTTPS协议。 ingress_port Integer 实例自定义入方向端口,支持的端口范围为1024~49151。
当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities 否 Array
Integer 流控的限定时间值 最小长度:1 最大长度:2147483647 reset_time 否 String 首次配额重置时间点,不配置默认为首次调用时间计算 remark 否 String 参数说明和描述。 不支持<,>字符 最大长度:255 响应参数 状态码: 201 表4
Integer 流控的限定时间值 最小长度:1 最大长度:2147483647 reset_time 否 String 首次配额重置时间点,不配置默认为首次调用时间计算 remark 否 String 参数说明和描述。 不支持<,>字符 最大长度:255 响应参数 状态码: 200 表4
实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 strategy_id 是 String 特殊配置的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。
类型 说明 customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。 如果使用该策略,需要将x-apigateway-access-control属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
持,可使用80默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该参数,则必须同时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。
AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 AUTHORIZER_IDENTITIES_FAILURE:自定义认证身份来源错误 BACKEND_UNAVAILABLE:后端不可用
是否支持对API的请求并发次数做控制? API调用是否存在带宽限制 怎样给指定的用户开放API? 导入导出API 导入API失败有哪些原因? 使用Swagger文件导入API时是否有模板?
当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities 否 Array
暂不支持,默认NORMAL auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_params String 访问参数。 表6 AuthResult 参数 参数类型
7:初始化失败 8:注册失败 10:安装中 11:安装失败 12:升级中 13:升级失败 20:回滚中 21:回滚成功 22:回滚失败 23:删除中 24:删除失败 25:注销中 26:注销失败 27:创建超时 28:初始化超时 29:注册超时 30:安装超时 31:升级超时 32:回滚超时
0/4 255.255.255.255/32 共享版:不支持。后端服务如为相同Region下的弹性云服务器,且弹性云服务器未绑定弹性IP地址,请使用VPC通道,不能直接填写弹性云服务器的私有地址。 父主题: 开放API