检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
sources”。 连续单击“Next”,选择“Maven”,最后单击“Create”。 IDEA支持在当前窗口或新窗口创建工程。此处,在弹窗中单击“New Window”。 创建IDEA maven工程 打开IDEA,在菜单栏选择“File > NEW > Project”。 在弹窗中选择“New
状态码: 202 表4 响应Body参数 参数 参数类型 描述 task_id String 任务id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数
String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数
证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数
ubject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 available_zones Array of AvailableZone objects 可用区列表 表4 AvailableZone 参数 参数类型 描述 name String
String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数
开放API的业务使用流程如下图所示。 图2 API网关服务开放API基本流程 创建实例 共享版无需购买实例,可直接进入共享版。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 绑定域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。
es/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选
使用API网关进行API的托管流程如下图所示。 图1 业务使用流程 创建用户并授权使用APIG 通过IAM服务创建用户并授权使用API网关,如果系统预置的APIG权限不满足授权要求,您也可以创建自定义策略。 创建APIG实例 实例是一个独立的资源空间,所有的操作都是在实例内进行,
APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用API(简易认证) 02:01 调用API(简易认证) API网关 APIG 介绍如何创建访问控制策略 01:52
String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数
X-Sdk-Date Origin:此字段必选,表示请求消息所属源。 Access-Control-Request-Method:此字段必选,表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。 后端服务返回消息:无
create_time String 创建时间。 update_time String 更新时间。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数 参数
以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403
validation String 参数校验表达式,默认为null,不做校验 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述
2:不包含 create_time String 创建时间 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code
响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of PluginInfo objects 插件列表。 表5 PluginInfo 参数 参数类型 描述 plugin_id String
健康检查的编号 create_time String 创建时间 状态码: 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表16 响应Body参数 参数 参数类型 描述 error_code