检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看APP未绑定的API列表 功能简介 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project
查看流控策略未绑定的API列表 功能介绍 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/t
req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间 update_time Timestamp 修改时间 remark String 描述 vpc_status String 是否使用VPC通道
维护操作通常几个月一次。 maintain_end 否 String 维护时间窗结束时间。时间格式为 xx:00:00,与维护时间窗开始时间相差4个小时。 在这个时间段内,运维人员可以对该实例的节点进行维护操作。维护期间,业务可以正常使用,可能会发生闪断。维护操作通常几个月一次。
API分组编号 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 本次查询返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号
invocation-type 是 String 函数调用类型,支持异步或同步。 timeout 否 Number 函数超时时间,单位毫秒,缺省值为5000,取值范围为1~60000。 父主题: APIG的API设计文件扩展定义
API分组编号 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 本次查询返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号
H、ANY。 path 是 String 后端请求路径,支持路径变量。 timeout 否 Number 后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000。 父主题: APIG的API设计文件扩展定义
维护操作通常几个月一次。 maintain_end 否 String 维护时间窗结束时间。时间格式为 xx:00:00,与维护时间窗开始时间相差4个小时。 在这个时间段内,运维人员可以对该实例的节点进行维护操作。维护期间,业务可以正常使用,可能会发生闪断。维护操作通常几个月一次。
req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间 update_time Timestamp 修改时间 remark String 描述 vpc_status String 是否使用VPC通道
CH、ANY path 是 String 后端请求路径,支持路径变量 timeout 否 Integer 后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000 description 否 String API后端描述 表19 后端httpVpcEndpoints参数说明
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gatew
H、ANY。 path 是 String 后端请求路径,支持路径变量。 timeout 否 Number 后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1~60000。 父主题: APIG的API设计文件扩展定义
查看API绑定的签名密钥列表 功能介绍 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign
后端超时(ms) 后端服务请求的超时时间,可填写范围1ms~60000ms。 如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。 说明: 如果当前的超时时间范围不能满足实际业务需求,请在实例配置参数中修改超时时间上限,可修改范围为1ms~600000m
time_interval 是 Integer 间隔时间:连续两次检查的间隔时间,单位为秒。必须大于timeout字段取值。 最小值:1 最大值:300 http_code 否 String 检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式:
与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示单位时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示单位时间内的单个IP地址请求次数上限。 API流量限制
的range_start的范围为0-9223372036854775807, range_start不大于range_end。 range_end 否 String 区间终止值。 为可以转换成integer的string,转换后的range_end的范围为0-9223372036854775807,
计算签名时,URI必须以“/”结尾。发送请求时,可以不以“/”结尾。 添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。 格式: 规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码: