检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Sta
SKIPPED:跳过 FAILED:授权失败 error_msg String 授权失败错误信息 error_code String 授权失败错误码 api_name String 授权失败的API名称 app_name String 授权失败的APP名称 状态码: 400 表7 响应Body参数
Array 解除绑定失败的ACL策略及错误信息 表5 failure参数说明 名称 类型 说明 bind_id String 解除绑定失败的ACL策略ID error_code String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id
offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 请求参数
AUTH_FAILURE: 认证失败,IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常,通信失败、返回异常响应等错误
offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 env_id
offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 请求参数
自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 第三方认证配置错误 500 第三方认证方异常,通信失败、返回异常响应等错误 第三方认证失败 401 第三方认证方返回认证失败
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
Array 解除绑定失败的ACL策略及错误信息 表5 failure参数说明 名称 类型 说明 bind_id String 解除绑定失败的ACL策略ID error_code String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id
AUTH_FAILURE: 认证失败,IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常,通信失败、返回异常响应等错误
offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 请求参数
自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 认证失败 401 认证失败,IAM或APP认证校验失败 认证身份来源缺失 401 认证身份来源信息缺失
String 实例创建状态 creating:创建中 success:创建成功 failed:创建失败 error_code String 实例创建失败错误码 error_msg String 实例创建失败错误信息 start_time Long 实例创建开始时间。unix时间戳格式。 end_time
objects 解除绑定失败的API和流控绑定关系及错误信息 表6 ThrottleBindingBatchFailure 参数 参数类型 描述 bind_id String 解除绑定失败的API和流控策略绑定关系ID error_code String 解除绑定失败的错误码 error_msg
offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 permission
AUTH_FAILURE: 认证失败,IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常,通信失败、返回异常响应等错误
类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code String 发布或下线失败的错误码 error_msg String 发布或下线失败的错误信息 响应消息样例: { "success":