检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
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协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机
Syntax)。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则,可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码,状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231(Hypertext
URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY,其中ANY表示该API支持任意请求方法。 请求协议:HTTP、HTTPS、HTTP&HTTPS,传输重要或敏感数据时推荐使用HTTPS。
进行身份认证,该认证方法直接传递密钥,在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256
其解析生成。 HTTP HTTP(Hyper Text Transfer Protocol)是超文本传输协议。 HTTPS HTTPS(Hyper Text Transfer Protocol over Secure Socket Layer)是安全版超文本传输协议。 REST
选择后端服务类型,此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择协议类型,此处选择“HTTP”。 后端服务地址:后端服务的地址。
安全性 涉及敏感信息或个人隐私数据的API,应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则,可保障API的安全合规。 API接口参数传输和存储过程中,敏感信息和个人隐私数据禁止明文传输和存储,避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括:
败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。 HTTP方法的需要符合幂等性的约束,幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用,单个资源操作,资源的标准CRUD操作对应的HTTP动词如表1所示。
联系技术支持。 400 APIC.0607 The following protocol is supported: {xxx} 改用支持的协议(HTTP/HTTPS)访问。 500 APIC.0608 Failed to obtain the admin token. 联系技术支持。 500
2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解绑域名”。 (可选)如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。
ey和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成APPCode 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。
务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:通过向系统提交工单,说明您的业务场景和诉求。
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。
定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 域名管理 在开放API前,您
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信
置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性
每个流控策略最多可以创建30个特殊租户。 子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集