Azure API 管理中的 API 网关

本文提供有关 API 管理网关组件的角色和功能的信息,并对可部署的网关进行比较。

相关信息:

网关的角色

API 管理网关(也称为数据平面或运行时)是负责代理 API 请求、应用策略和收集遥测的服务组件。

具体而言,网关执行以下操作:

注意

对 API 管理网关的所有请求(包括被策略配置拒绝的请求)都将计入所配置的速率限制、配额和计费限制(如果服务层级中已应用)。

托管和自托管

API 管理提供托管网关和自托管网关:

  • 托管 - 托管网关是 Azure 中为每个服务层级中的每个 API 管理实例部署的默认网关组件。 使用托管网关,无论实现 API 的后端托管在何处,所有 API 流量都流经 Azure。

    注意

    由于基础服务体系结构存在差异,因此消耗层网关当前缺少专用网关的一些功能。 有关详细信息,请参阅功能比较:托管网关与自托管网关部分。

  • 自托管 - 自托管网关是默认托管网关的可选容器化版本。 它对于混合和多云方案非常有用,在这些方案中,要求在托管 API 后端的同一环境中从 Azure 运行网关。 使用自托管网关,具有混合 IT 基础结构的客户可以从 Azure 中的单个 API 管理服务管理本地和云中托管的 API。

    • 自托管网关将打包为基于 Linux 的 Docker 容器,通常部署到 Kubernetes,包括 Azure Kubernetes 服务

    • 每个自托管网关都与基于云的API 管理实例中的网关资源相关联,它从该实例中接收配置更新并传递状态。

重要

对 Azure API 管理自承载网关版本 0 和版本 1 容器映像的支持及其相应配置 API v1 将于 2023 年 10 月 1 日结束。 使用迁移指南,将自承载网关 v2.0.0 或更高版本与配置 API v2 结合使用。 在弃用文档中了解详细信息

功能比较:托管网关与自托管网关

下表比较了托管网关与自托管网关中的可用功能。 专用服务层级(开发人员、基本、标准、高级)的托管网关与消耗层的托管网关之间也存在差异。

注意

  • 托管和自托管网关的某些功能仅在某些服务层级或自托管网关的某些部署环境中受支持。
  • 要使用当前支持的自承载网关功能,请确保已升级到自承载网关容器映像的最新主版本。
  • 另请参阅自托管网关限制

基础结构

功能支持 托管(专用) 托管(消耗) 自承载
自定义域
内置缓存
外部 Redis 兼容缓存
虚拟网络注入 开发人员、高级 ✔️1,2
专用终结点
多区域部署 高级 ✔️1
CA 根证书,用于证书验证 ✔️3
托管域证书
TLS 设置

1 取决于网关的部署方式,但由客户负责。
2 连接到自承载网关 v2 配置终结点需要终结点主机名的 DNS 解析。
3 自承载网关的 CA 根证书是按网关单独管理的
4 需要启用客户端协议。

后端 API

API 托管(专用) 托管(消耗) 自承载
OpenAPI 规范
WSDL 规范
WADL 规范
逻辑应用
应用服务
函数应用
Service Fabric 开发人员、高级
直通 GraphQL
Synthetic GraphQL ✔️1 ✔️1
直通 WebSocket
直通 gRPC
后端中的断路器
负载均衡后端池

1 不支持 Synthetic GraphQL 订阅(预览版)。

策略

托管和自托管网关支持策略定义中的所有可用策略,但以下策略例外。

策略 托管(专用) 托管(消耗) 自承载1
Dapr 集成
GraphQL 解析程序GraphQL 验证
获取授权上下文
配额和速率限制 ✔️2 ✔️3

1 在执行策略期间,将跳过自承载网关不支持的已配置策略。
2 按密钥限制速率策略和按密钥的配额策略在消耗层级不可用。
3 可以将自承载网关中的速率限制计数配置为在本地同步(在群集节点中的网关实例之间),例如,通过 Kubernetes 的 Helm 图表部署或使用 Azure 门户部署模板。 但是,速率限制计数不会与 API 管理实例中配置的其他网关资源同步,包括云中的托管网关。 了解详细信息

监视

有关监视选项的详细信息,请参阅 Azure API 管理中的可观测性

Feature 托管(专用) 托管(消耗) 自承载
API 分析
Application Insights
通过事件中心进行日志记录
Azure Monitor 中的指标
OpenTelemetry 收集器
Azure Monitor 和 Log Analytics 中的请求日志 1
本地指标和日志
请求跟踪

1 自托管网关当前不会向 Azure Monitor 发送资源日志(诊断日志)。 可以将指标发送到 Azure Monitor,或在部署自托管网关的本地配置和保存日志

网关吞吐量和缩放

重要

吞吐量受以下因素影响:并发客户端连接的数量和速率、配置策略的种类和数量、有效负载大小、后端 API 性能等。 自托管网关吞吐量也取决于运行它的主机的计算容量(CPU 和内存)。 使用预期的生产条件执行网关负载测试,以准确确定预期的吞吐量。

托管网关

有关 API 管理服务层级中估计的最大网关吞吐量,请参阅 API 管理定价

重要

吞吐量数据仅供参考,不能作为容量和预算计划的依据。 有关详细信息,请参阅 API 管理定价

  • 专用服务层级

    • 通过添加和删除缩放单元来缩放网关容量或升级服务层级。 (缩放在开发人员层不可用。)
    • 在标准层和高级层中,可以选择配置 Azure Monitor 自动缩放
    • 在高级层中,可以选择跨多个区域添加和分配网关容量。
  • 消耗层

    • 消耗层中的 API 管理实例会根据流量自动缩放。

自承载网关

  • Kubernetes 等环境中,添加多个网关副本以处理预期使用情况。
  • (可选)配置自动缩放以满足流量需求。