检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因: 语义有误,当前请求无法被服务器解析; 请求参数有误。 401
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略在当前实例中不支持
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务(即API的提供者
怎样保证API网关调用后端服务器的安全? 通过以下方法确保API网关调用后端服务器的安全: 为API绑定签名密钥。 在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。 使用HTTPS对请求进行加密
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups
域名绑定SSL证书 功能介绍 域名绑定SSL证书。目前暂时仅支持单个绑定,请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用
SSL证书绑定域名 功能介绍 SSL证书绑定域名。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates
AK/SK认证 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{group_id}/domains/{domain_id
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 本章节主要介绍为特定域名绑定证书。 调用方法
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 如果不配置SSL证书,将无法保障请求的链路安全,请谨慎配置。 单向认证:客户端与服务端连接时
查看域名证书 功能介绍 查看域名下绑定的证书详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate
使用APIG专享版跨VPC开放后端服务实施步骤 创建VPC 登录网络控制台。 在左侧导航栏选择“虚拟私有云 > 我的VPC”。 在“虚拟私有云”页面,单击“创建虚拟私有云”,请参考表1和表2配置信息。具体操作请参考《虚拟私有云服务用户指南》中的“创建虚拟私有云和子网”章节。 表1
通过CCE工作负载导入API API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云