检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请求中,或者作为查询字符串参数添加到HTTP请求中。 API网关收到请求后,执行1~3,计算签名。 将3中的生成的签名与5中生成的
默认值:45000,请求参数值不在合法范围内时将使用默认值 remark 否 String 描述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 vpc_status 否 Integer 是否使用VPC通道: 1 : 使用VPC通道 2 : 不使用VPC通道 vpc_info
CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境,仅在mode为CONSUMER时有效,未提供时有如下默认值:
API创建完成后,在“API运行”页签中,单击“发布最新版本”,发布API。 使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为APIG控制台“实例信息”中的弹性IP地址。 父主题: 开放API
描述 CRU 否 vpc_status Integer 是否使用VPC通道 1:使用 2:不使用 CRU 否,默认不使用 vpc_info String VPC通道信息 CRU 否 如果vpc_status=1,即:使用VPC通道,则该字段必填 authorizer_id String
方法 仅在“Method”为“ANY”时,支持修改。 路径 仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数 仅在“Path”中存在“{}”时,支持修改。 请求头 HTTP Headers的参数与参数值。 查询参数 Query的参数与参数值。 Body 仅在“Meth
tcp http CRU 是 path Integer 路径,仅当协议为http时生效 CRU 否 port Integer 端口,无值时,使用通道端口 CRU 否 threshold_normal Integer 正常阈值 CRU 是 threshold_abnormal Integer
查看流控策略未绑定的API列表 绑定流控策略 查看流控策略绑定的API列表 查看API绑定的流控策略列表 解除绑定 父主题: 共享版API(仅存量用户使用)
云商店订购信息查询 查询已购买的API分组列表 查询分组详情 查询已购买的API列表 父主题: 共享版API(仅存量用户使用)
0策略相当于流量控制2.0策略同步绑定了API。同一个环境中,一个API只能被一个流量控制2.0策略绑定,但一个流量控制2.0策略可以绑定多个API。(使用前提是绑定的API已发布。) 如果API未绑定流量控制2.0策略,流控限制值为实例“配置参数”中“ratelimit_api_limits”的参数运行值。
字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 vpc_status 否 Integer 是否使用VPC通道: 1 : 使用VPC通道 2 : 不使用VPC通道 vpc_info 如果vpc_status=1,则这个字典类型为必填信息 字典类型 VPC通道详情 authorizer_id
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
签名密钥 创建并使用签名密钥 删除签名密钥 父主题: 共享版操作指导(仅存量用户使用)
String 使用以下协议,对VPC中主机执行健康检查。 TCP HTTP HTTPS path protocol = http时必选 String 健康检查时的目标路径。 说明: 需要服从URI规范。 port 否 Integer 健康检查的目标端口,缺省时为VPC中主机的端口号。
HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 version_id 是 String API版本的编号 请求消息 无 响应消息
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
其中ANY表示该API支持任意请求方法。 使用VPC通道 是否使用VPC通道访问后端服务。 如果使用VPC通道,选择已创建的VPC通道名称。 VPC通道中,云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。 如果不使用VPC通道,需要设置后端服务地址。
表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String API的编号 请求消息 无 响应消息 无 状态码
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/validation/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明