检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
API网关认证方式,支持AppSigv1、IAM。 type 是 String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
如果需要批量解绑API,则勾选待解绑的API,单击“解除”。最多同时解绑1000个API。 后续操作 如果某个应用希望受流量策略控制,可以通过对该策略增加特殊应用实现,具体参考添加特殊应用或租户。增加特殊应用后,此应用的应用流量受特殊应用的阈值限制,而API流量和用户流量受流量策略限制。
0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号,可通过查询APP列表获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字
该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 app_call_limits 否 Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 ip_call_limits
group_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:api_id、api_name、group_id 、group_name 、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
x-apigateway-any-method 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。 作用域:Path Item Object(2.0)/Path Item Object(3.0) 示例: paths: '/path': get:
0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String App Code值
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
将生成的签名信息作为请求消息头添加到HTTP请求中,或者作为查询字符串参数添加到HTTP请求中。 API网关收到请求后,执行1~3,计算签名。 将3中的生成的签名与5中生成的签名进行比较,如果签名匹配,则处理请求,否则将拒绝请求。 约束与限制 APP签名仅支持Body体12M及以下的请求签名。 步骤1:构造规范请求
查询APP概况 功能介绍 查询租户名下的APP概况:已进行API访问授权的APP个数,未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_
oken的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 app_codes Array of AppCodeBaseInfo objects App Code列表
单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个IP流控时间内能够访问API的次数限制 time_interval Integer 流控的时长 time_unit
用API示例。 调用API示例 在代码中引入sdk。 1 require 'signer.php'; 生成一个新的Signer, 填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SD
der”的初始值为空,与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”,那么对于APP认证的API,请求header中携带APP认证信息的参数为此处“app_auth_header”的值;如果配置“backend_sign_header”的“参数运行
type: APP limit: 100 instance: xxxxxxxxx 表1 参数说明 参数 是否必选 类型 说明 customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。
类型 说明 type 是 String 特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义
_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:acl_id、api_id、 api_name、group_id、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选