检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
Syntax)。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则,可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码,状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231(Hypertext
Access-Control-Allow-Origin: http://www.cors.com {"status":"200"} Access-Control-Allow-Origin:表示后端服务接受“http://www.cors.com”的请求。 API网关响应消息: HTTP/1.1 200 OK Date:
创建服务器分组,填写分组名称、权重和描述。 添加后端服务器地址,填写后端服务地址,设置是否启用备用节点。 配置健康检查。 表2 基本信息配置 信息项 描述 协议 使用以下协议,对负载中主机执行健康检查。 TCP HTTP HTTPS 默认为TCP协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。
其解析生成。 HTTP HTTP(Hyper Text Transfer Protocol)是超文本传输协议。 HTTPS HTTPS(Hyper Text Transfer Protocol over Secure Socket Layer)是安全版超文本传输协议。 REST
最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述
选择后端服务类型,此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择协议类型,此处选择“HTTP”。 后端服务地址:后端服务的地址。
败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。 HTTP方法的需要符合幂等性的约束,幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用,单个资源操作,资源的标准CRUD操作对应的HTTP动词如表1所示。
流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 父主题: 安全
S协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算,在API请求过程中不会直接传递SignKey,同时对请求时间进行有效校验,避免重复请求攻击。
ey和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成APPCode 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
仅在“类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时,需要设置。支持输入多个账号名,以英文“,”隔开,如aaa
支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解绑域名”。 (可选)如果AP
本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。 在API设计过程中,使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中,POST请求是向指定的资源提交要被处理的数据,其响应不会被缓存;PUT请求用来提交数据时,其响应是不能被缓存的。 父主题: API生产
API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)
细信息对话框。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集
量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API