检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 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协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。
支持WebSocket通信。 定义的后端服务协议须与用户的后端业务协议保持一致。 负载通道(可选) 仅在使用负载通道时,需要设置。选择已创建的负载通道名称。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 格式:“主机:端口”,主机为IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。
选择后端服务类型,此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择协议类型,此处选择“HTTP”。 后端服务地址:后端服务的地址。
其解析生成。 HTTP HTTP(Hyper Text Transfer Protocol)是超文本传输协议。 HTTPS HTTPS(Hyper Text Transfer Protocol over Secure Socket Layer)是安全版超文本传输协议。 REST
流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 父主题: 安全
S协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算,在API请求过程中不会直接传递SignKey,同时对请求时间进行有效校验,避免重复请求攻击。
败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。 HTTP方法的需要符合幂等性的约束,幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用,单个资源操作,资源的标准CRUD操作对应的HTTP动词如表1所示。
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.
本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。 在API设计过程中,使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中,POST请求是向指定的资源提交要被处理的数据,其响应不会被缓存;PUT请求用来提交数据时,其响应是不能被缓存的。 父主题: API生产
支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解绑域名”。 (可选)如果AP
细信息对话框。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况
每个流控策略最多可以创建30个特殊租户。 子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足
量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API
度限制对API的调用次数,保护后端服务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 支持区域:
资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。
资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。