检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。
04已添加到负载通道中,此时API网关代理通过负载通道可以直接访问负载中的ECS 01和ECS 04。 图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。
束。 必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则,可保障API的高可用性。 API调用成功定义
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份,在API网关代理请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息,此时
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。 使用限制
帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项
如何对API进行商业售卖? 您可以通过华为云云商店,将API作为商品对外售卖。具体参见发布API类商品操作指南。 父主题: API售卖与技术支持
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则,可保障API的可维护性。 现网API版本一般保留3个版本或以下,如果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
单个IP地址请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用,表示“时长”时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅在API的安全认证方式为“华为IAM认证”时适用。 不能大于“API流量限制”的值。 与“时长”配
(URI): Generic Syntax)。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则,可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码,状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC
是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API调用流量之后,才启动正式下线。待该API到了正式下线后,API中心不再展示下线的API。 父主题: API开放
新增API订阅管理 支持在控制台对门户网站中已订阅的API进行管理,包括查看订阅的所有API以及取消订阅API。 公测 API订阅管理 2 优化创建API资产 创建API资产时,不需要填写API来源。 公测 API资产管理 3 修改API网关代理中部分配置项的限制值 修改API网关
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集
约束与限制 API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
华北-北京四 API资产管理 API中心服务商可在API中心管理控制台管理API资产。 华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。 华北-北京四 API门户 API中心
谁为API使用者提供技术支持? API中心主要是作为API汇聚和运营API的平台,支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务,由API提供方即API服务商负责。 父主题: API售卖与技术支持