正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
签名密钥编号 name 否 String 签名密钥名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的签名密钥的数量 size Integer 本次返回的列表长度
PI生效。 同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。 如果API未绑定流控策略,共享版API网关系统默认流控限制为200次/秒。 前提条件 需要绑定的API已发布。 创建流控策略 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。
(白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
、“Basic Auth”、“AES”和“Public Key”。 在实例的配置参数中开启“public_key_enable”功能后,才支持选择“Public Key”类型。 签名算法 选择aes的签名算法,包含以下两种: aes-128-cfb aes-256-cfb Key
头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 响应名称。支持英文、数字、下划线、中划线,1-64个字符。 responses 否 Map<String,ResponseInfo> 错误类型的响应定义
此处选择已创建的API分组。 URL 请求方法:接口调用方式,此处选择“ANY”。 请求协议:选择API请求协议,此处选择“HTTPS”。 子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 路径:接口请求路径。 网关响应 API网关未能成功处理AP
头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 响应名称。支持英文、数字、下划线、中划线,1-64个字符。 responses 否 Map<String,ResponseInfo> 错误类型的响应定义
Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控: TRUE FALSE 暂不支持 响应消息样例: { "id": "0325b671-2d50-4614-9868-22102262695d", "name": "每秒1000次"
参数类型 描述 group_name 是 String 待校验的API分组名称 roma_app_id 否 String 集成应用ID 暂不支持 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。 应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)key&secret。将指定的API授权给指定应用(凭据)后,该应用(凭据)的持有者才可以调用已发布到环境中的指定API。
page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer
响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 offsell_nums Integer 未上架的API分组个数 暂不支持 onsell_nums Integer 已上架的API分组个数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer
类型 PERMIT (白名单类型) DENY (黑名单类型) app_acl_values Array of strings ACL策略值,支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。
group_id 否 String 分组ID。 校验分组下API定义是否重复时必填 roma_app_id 否 String 集成应用ID 暂不支持 api_id 否 String 需要对比的API ID type 是 String 校验类型: path:路径类型 name:名称类型 枚举值:
String API的发布记录编号 scope Integer 策略作用域,取值如下: 1: 整个API 2: 单个用户 3: 单个APP 目前只支持1 apply_time Timestamp 绑定时间 响应消息样例: { "throttle_applys": [{ "id":
最大值:300 http_code 否 String 检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 protocol