检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
charset=utf-8。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建API分组接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001", "remark": "分组1" } 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、
类型 说明 id 是 String VPC通道的编号。 inst_id 是 String 后端实例对象的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request 401 Unauthorized 403
字符串长度最大不超过255。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001", "remark": "分组001" } 响应消息 表4 参数说明 名称 类型 说明 id String 编号 name String
息中获取。 id 是 String VPC通道的编号。 inst_id 是 String 后端实例对象的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request 401 Unauthorized 403
且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 请求消息样例: { "app_secret": "app_secret_sample" } 响应消息 表4 参数说明 参数 类型 说明 id String 编号 name String
且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义密钥值。 请求消息样例: { "app_secret": "app_secret_sample" } 响应消息 表4 参数说明 参数 类型 说明 id String 编号 name String
16 ~ 64字符。 未填写时后台自动生成。 请求消息样例: { "name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******" } 响应消息 表4 参数说明 参数 类型 说明 id String
String 云服务器的名称。 page_size 否 Integer 每页显示的云服务器数量,默认值:20。 page_no 否 Integer 页码,默认值:1。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的云服务器总数。 size
断路器策略是API网关在后端服务出现性能问题时保护系统的机制,支持通过熔断降级的方式保护后端服务。 身份认证策略支持通过AKSK、Token等多种方式进行服务认证,支持用户通过函数自定义API访问认证逻辑,支持对后端服务进行证书校验,支持签名密钥用于后端服务验证API网关的身份。 VPC通道(负载通道)
String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制 请求消息样例: { "call_limits": 180 } 响应消息 表4 参数说明 参数 类型 说明
String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制 请求消息样例: { "call_limits": 180 } 响应消息 表4 参数说明 参数 类型 说明
扩展信息导入模式,可选merge和override。 当扩展信息定义冲突时,merge保留原有扩展信息,override会覆盖原有扩展信息。 请求消息 表3 参数说明 名称 是否必选 参数类型 说明 swagger 是 String 固定值2.0 info 是 Object 参考表4 paths
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
on下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、
发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、