控制台和登录入口整合在这里了。

确定

API 网关

API 网关(API Gateway),提供高性能、高可用的 API 托管服务,用户只需简单操作,即可快速、低成本、低风险的开放数据或服务。

立即开通 联系销售

API 网关

API 网关为您提供完整的 API 托管服务,辅助用户将能力、服务、数据以 API 的形式开放给合作伙伴。

  • 提供防攻击、防重放、请求加密、身份认证、权限管理、流量控制等多重手段保证 API 安全,降低 API 开放风险。

  • 提供 API 定义、测试、发布、下线等全生命周期管理,并生成 SDK、API 说明文档,提升 API 管理、迭代的效率。

  • 提供便捷的监控、报警、分析等运维、运营工具,降低 API 运营、维护成本。

API 网关将能力的复用率最大化,企业间能够互相借力,企业发展能够专注自身业务,实现共赢。

优点

解放生产力

完成 API 录入后,即可告别 API 管理的一切繁杂,API 网关为您解决 API 文档维护、SDK维护、API 版本管理等繁琐事务,大大降低您的日常维护成本。

只为实际服务付费

免费开通,API 日常管理、生成文档、生成 SDK、流量控制、权限控制,均不需要付费。您只需为 API 的实际调用付费。

大规模且高性能

API 网关采用分布式部署,自动扩展,能够承载大规模的 API 访问;同时还能保证较低的延时,为您的后端服务提供高保障高效率的网关功能。

安全稳定

您的服务只需在内网对 API 网关开放,不必顾虑安全问题。API 网关还提供严格的权限管理功能、精准的流量控制功能、全面的监控报警功能,让您的服务安全、稳定、可控。

场景

API 网关能够支撑您在各个场景下开放 API 的需求,支持将 API 开放给合作伙伴、开发者,实现企业核心能力的货币化,建立 API 生态;支持将 API 适配多端,如:移动、互联网、物联,实现系统前后端分离;支持内部系统整合模块化、微服务化。

1,建立 API 生态,互相借力,协同发展

面对用户日益膨胀而又碎片化的需求,企业需要不断探索新的商业模式,来解决客户一系列的场景化问题。通过API网关提供标准的 API 服务,让其他开发者将不同 API 服务组合整合到自己的应用中,衍生出新的服务,促进企业建立商业生态、跨界创新。

  • 通过 API 网关将企业的核心能力,开放给合作伙伴,达成深度合作,协同发展;

2,安全的实现多端统一,一套服务,多端输出

随着移动、物联网的普及,API 需要支持更多的终端设备,以扩充业务规模,但同时也带来系统复杂性的提升。通过 API 网关可以使 API 适配多端,企业只需要在 API 网关调整 API 定义,无需做额外工作。

  • 企业只需维护一个服务体系,面向多端输出,只需调整API定义,即可实现对APP、设备、web端等多种终端的支持;

  • 避免多个场景多套API,大大降低管理运维成本。

3,轻松实现系统集成,规范化、标准化

  • 通过 API 网关对系统间接口进行规范统一,用标准化的接口实现系统集成;

  • 快速完成资源整合和管理,消除快速发展造成的冗余和浪费,聚力发展业务。

产品详情

下面为 API 网关产品主要功能点。


功能

API 生命周期管理

  • 支持包括 API 发布、API 测试、API 下线等生命周期管理功能。

  • 支持 API 日常管理、API 版本管理、API 快速回滚等维护功能。

全面的安全防护

  • 支持多种认证方式,支持 HMAC (SHA-1,SHA-256) 算法签名。

  • 支持 HTTPS 协议,支持 SSL 加密。

  • 防攻击、防注入、请求防重放、请求防篡改。

灵活的权限控制

  • 用户以 APP 作为请求 API 的身份,网关支持针对 APP 的权限控制。

  • 只有已经获得授权的 APP 才能请求相应的 API。

  • API 提供者可以主动授权某个 APP 调用某个 API 的权限。

精准的流量控制

  • 流量控制可以用于管控 API的被访问频率、APP的请求频率、用户的请求频率。

  • 流量控制的时间单位可以是分钟、小时、天。

  • 同时支持流控例外,允许设置特殊的 APP 或者用户。

请求校验

  • 支持参数类型、参数值(范围、枚举、正则、Json Schema)校验,无效校验直接会被 API 网关拒绝,减少无效请求对后端造成的资源浪费,大大降低后端服务的处理成本。

数据转换

  • 通过配置映射规则,实现前、后端数据翻译。

  • 支持前端请求的数据转换。

监控报警

  • 提供可视化的API实时监控,包括:调用量、流量大小、响应时间、错误率,在陆续增加维度。

  • 支持历史情况查询,以便统筹分析。

  • 可配置预警方式(短信、Email),订阅预警信息,以便实时掌握API运行情况。

自动工具

  • 自动生成 API 文档,可供在线查看。

  • API 网关提供多种语言 SDK 的示例。降低 API 的运维成本。

  • 提供可视化的界面调试工具,快速测试,快速上线。

定价

API网关仅对开放API的用户按下述既定价格收费。

API Gateway 计费分两个维度:调用量(次数)、流量。两个维度有各自的计费规则,同时计费。

API网关支持免费开通服务、免费创建API、免费发布API、免费管理API。

当API被调用时,所产生的调用量(次数)和流量将同时计入收费。

按【调用量(次数)】计费说明

开通网关服务后,第一年每月(自然月)前一百万次调用免费,当月超过部分按照下表阶梯计费。

按阶梯计费月累计超过次数单位:美元/百万次
第一阶梯0~1000万(包含)0.9
第二阶梯1000万~1亿(包含)0.6
第三阶梯1 亿以上0.45

按调用量(次数)计费说明:

a) 计费项:API调用量(次数)

b) 计费方式:按量后付费

c) 计费周期:月

d) 账单时间: 账单出账时间通常在当前计费周期结束后一小时内,最长不超过三个小时

e) 计费币种:美元

f) 有效调用次数: API网关收到的所有API请求,均为有效调用,会计入收费范围

按【流量】计费说明

按照下行流量计费,流量价格如下表:

计费项价格单位中国大陆香港亚太东南1(新加坡)亚太东南 3 (吉隆坡)欧洲中部 1 (法兰克福)
流量(下行流量)美元/GB0.1250.1560.1170.1120.07

按流量计费说明:

a) 计费项:流量费用(下行流量)

b) 计费方式:按量后付费

c) 计费周期:月

d) 账单时间: 账单出账时间通常在当前计费周期结束后一小时内,最长不超过三个小时

e) 计费币种:美元

f) 若您的后端服务与API网关不在同一区域,或后端服务不在阿里云,我们将会额外收取API网关到您后端服务的流量费用。收费标准同上表

使用须知

A. 服务暂停

欠费后,则您的API将停止被调用(API管理相关操作可以进行),并会以短信/邮件的方式提醒您续费。

B. 服务恢复

服务被暂停后半年内,您成功充值后,服务可自动开启,并继续使用。超过半年,API网关将有权清理您API配置信息。

使用入门

本页内容对 API 网关提供的文档进行说明,方便您尽快找到对应的说明文档。

您可以通过 API 网关开放 API,也可以通过 API 网关请求他人开放的 API。

您在查看文档时,请注意区分使用目的。

若您使用 API 网关开放 API,请查看:

使用手册(开放 API) 快速入门(开放 API)

若您使用 API 网关请求他人开放的 API,请查看:

使用手册(调用 API) 快速入门(调用 API)

当然,您可以通过 API 网关的 API 和 SDK 来使用产品。

现在就开始录入 API 吧!

资源

下面提到的 API 和 SDK 是由 API 网关对外提供的接口和工具,您可以通过这些使用 API 网关产品,取代您在 API 网关控制台的操作。

请将下方 API 与用户在 API 网关开放的 API 进行区别,同时用于请求他人开放 API 的 SDK 请前往控制台SDK 下载页面查看。

前往控制台下载 SDK

开发者资源

常见问题

1. 产品有什么使用限制?

请参照产品使用限制相关文档:

使用限制(调用 API) 使用限制(开放 API)

2. 是否需要额外购买安全产品?

取决于您API的安全要求。API 网关会为您解决 API 开放过程中的基本安全问题,包括对请求者进行身份认证、请求加密、请求防篡改等等。若您有更高的安全要求,需要结合其他安全产品使用。

3. 是否需要为 API 网关购买 SLB?

API 网关会为您解决从客户端到网关的负载均衡,网关自身会根据请求量自动扩展。若您后端服务为多台 Ecs,则多台 Ecs 之间可通过 Slb 实现负载均衡。

4. 使用产品欠费会怎么样?

API 网关是后付费产品,若您有账单未能及时结算,则 API 网关认为您为欠费状态。欠费期间您的 API 服务将被禁止调用,欠费时间达到6个月,则 API 网关有权删除您的配置信息。

5. 为什么 API 网关无法调通我的后端服务?

请检查您录入的后端服务地址是否正确。

保证您的后端服务可以正常访问。

如后端服务在 Ecs ,请检查安全组设置,是否可以被外部访问。请保证安全组允许 API 网关的 IP 段访问。

IP 段查询

如果后端服务地址是内网 IP ,请保证您的后端服务与您的 API 处于同一Region。

6. 用户传入一个未定义的参数,API 网关会如何处理?

API 网关会将该参数抛弃,不会传递给后端服务。

7. 是否支持 HTTPS 协议?

可以,在录入后端服务地址时,请以“ https:// ”开头,且需要保证您的后端服务 SSL 证书有效。

8. API 发布是否有延时?

即时生效,请谨慎操作。

9. API 网关监控功能的时效性?

基本是实时的监控信息,最大延迟不超过1分钟。

10. 如何选择分组的Region?

请尽量选择和后端的ECS、Docker相同的地域。

11. 分组的二级域名是什么?有何限制?

分组的二级域名是 API 网关分配给每个 API 分组的,只能用于 API 测试调用的阶段,不建议对外开放该二级域名。该分组下的所有 API 共用同一个二级域名。直接访问二级域名请求 API 的话,每天的访问上限是 1000 次。

12. 独立域名是什么?

如果您要对外开放 API 服务,您需要给 API 所在分组绑定独立域名。其他人调用您开放的 API 服务需要访问该独立域名。独立域名可以是某个域名的二级、三级域名,绑定前需要先 CNAME 解析到分组的二级域名上。

13. 如何保证网关到后端服务器的调用安全?

您可以在 API 网关配置后端签名密钥,亦可使用 HTTPS 对请求进行加密。

后端签名密钥

14. 更换后端密钥是否需要发布API?

不需要,您只需要创建新的密钥,然后绑定到 API 上即可。

15. 如何不中断服务更换后端密钥?

由于密钥与 API 绑定后即时生效,要想不间断的完成密钥更新,需要您后端先同时支持新旧两个密钥,更换完毕后再结束对旧密钥的支持。

16. APP 是什么?

APP 是由请求者创建的,作为请求 API 服务的身份。每个 APP 有 AppKey 和 AppSecret,这对密钥参与请求签名。API 网关面向 APP 做签名验证和权限验证。

17. 如何实现权限控制?

在 API 网关请求 API 服务需要创建 APP 作为请求者的身份,请求者只有获得开放者的授权或者购买了 API 服务才有权请求 API。

18. API 调用失败?

请依次检查下属各项:

  • 检查域名是否解析;

  • 检查域名是否已经绑定到分组;

  • 检查API是有已发布;

  • 检查使用的AppKey是否被授权;

  • 后端服务地址是否正确,是否能正常访问;

  • 检查超时时间配置是否正确,请确保后端服务在设置的超时时间内返回;

  • 检查是否超出超出流控限制。

错误信息查询请参照文档

错误码表