检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用已发布的API 调用API 响应消息头 错误码
API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
R 是 instance_id String 实例的编号 CRU 否 instance_name String 实例的名称 CRU 否 host String 后端实例对象的主机地址 CRU 是 status Integer 后端实例对象状态 1:正常 2:异常 R 是 weight
响应缓存策略说明 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API
可视化API监控面板 帮助您监控API调用性能指标、数据延迟以及错误等信息,识别可能影响业务的潜在风险。 多层安全防护 API网关具备SSL传输、严格的访问控制、IP黑白名单控制、认证鉴权、防重放防攻击、多种审计等安全措施,全方位保护API安全调用,且能实施灵活而精细的配额管理及流控管理以保护
扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64 x-apigateway-any-method
位时间,以此类推。 时长 填写配额限制的时长,单位可选择“秒”、“分”、“时”和“天”。需与“API访问限制”配合使用,表示单位时间内客户端可调用API的总次数上限。 API访问限制 填写客户端可调用API的次数上限,与“时长”配合使用。 描述 填写客户端配额策略的描述信息。 策略配置完成后,单击“确定”。
0000,默认5000 单位:毫秒。 最小值:1 缺省值:5000 auth_type 否 String API的认证方式,默认无认证。 NONE:无认证 APP:APP认证 IAM:IAM认证 缺省值:NONE cors 否 Boolean 是否支持跨域,默认不支持 true:支持
专享版-微服务中心管理 导入微服务 父主题: 专享版API(V2)
API流量控制 是否支持对请求并发次数做自定义控制? 每个子域名(调试域名)每天最多可以访问1000次,如果账号为企业账号,是否还有这个限制? API调用是否存在带宽限制 流量控制策略不生效怎么办? 父主题: API控制策略
时,默认开启客户端认证即双向认证;反之,开启单向认证。 单向认证:客户端与服务端连接时,客户端需要校验服务端SSl证书合法性。 双向认证:客户端与服务端连接时,除了客户端需要校验服务端SSl证书合法性,服务端也需要校验客户端SSl证书合法性。 父主题: 使用API网关专享版与客户端进行认证
project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String
project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选
概要查询 查询API分组概况 查询API概况 查询APP概况 父主题: 共享版API(仅存量用户使用)
String 实例ID,在API网关控制台的“实例信息”中获取。 task_id 是 String 异步任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接
不支持HTTP。 每个凭据最多可创建5个AppCode。 生成APPCode 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。
否 String 签名密钥的编号 sign_name 否 String 签名密钥的名称 env_id 否 String 环境编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的签名密钥总数 size Integer 本次查询返回的签名密钥列表长度
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
环境管理 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 共享版API(仅存量用户使用)
表1 参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型,支持APP、USER limit 是 Number 访问次数 instance 是 String 特殊APP或USER的对象标识 父主题: 扩展定义