文档中心

API 网关

实例管理

创建实例

使用 API 网关之前，首先需要创建资源相互隔离的网关实例。本文为您介绍如何创建一个 API 网关实例。

说明

【邀测·申请试用】

弹性网关目前处于邀测阶段，如需使用，请联系您的客户经理。

目前弹性网关只支持以下地域：华北2（北京）、华东2（上海）、华南1（广州）、亚太东南（柔佛）。

实例类型对比

规格与限制	标准型网关	弹性网关	Serverless 网关
适用场景及建议	适合正式生产环境，面向中大规模业务	适合中小规模正式生产环境，潮汐式或间歇型业务场景	适用于在函数服务（veFaas）场景下的固定规格实例
云资源	实例资源均为单用户独享	实例资源被多用户共享，资源本身可根据业务使用情况进行资源的弹性扩容	单实例资源独享，单实例规格固定大小 1c2g、2 副本，不支持按需调整
SLA	99.95%	99.9%	99.95%
收费方式	实例规格费用（后付费/预付费）+ 网络流量计费	调用量 + 网络流量计费	实例规格费用（后付费/预付费）+ 网络流量计费
服务 QPS	无硬性上限，建议根据所选资源规格的推荐值合理使用，具体请参见性能说明	1000	无硬性上限，建议根据所选资源规格的推荐值合理使用，具体请参见性能说明
公网入口地址	独享，IP 地址固定	多租户共享，IP 地址不固定	独享，IP 地址固定
公网后端出口带宽	独享出口 IP 与带宽， IP 地址固定	多租户共享出口 IP 与带宽， IP 地址不固定	独享出口 IP 与带宽， IP 地址固定
后端最大超时时间限制	不限制	1800s	不限制
请求包体限制	不限制	16MB	不限制
后端服务类型	完整的网关功能，支持对接容器服务（VKE），云服务器（ECS），函数服务（veFaas）多种后端服务	支持对接函数服务（veFaas）、固定域名的后端服务	仅支持对接函数服务（veFaas）类型的后端服务
Trace 日志	支持	不支持	支持
记录 HTTP 请求应答日志	支持	支持	支持
最大入访每秒新建连接数	无硬性上限，建议根据所选资源规格的推荐值合理使用，具体请参见性能说明	5000	无硬性上限，建议根据所选资源规格的推荐值合理使用，具体请参见性能说明
最大出访连接池大小	无硬性上限，建议根据所选资源规格的推荐值合理使用	2000	无硬性上限，建议根据所选资源规格的推荐值合理使用
最大公网入访带宽（bps）	无硬性上限，建议根据所选资源规格的推荐值合理使用	支持对接函数服务（veFaas）、固定域名的后端服务	无硬性上限，建议根据所选资源规格的推荐值合理使用
最大公网出访带宽（bps）	无硬性上限，建议根据所选资源规格的推荐值合理使用	多租户共用，总的最大公网出访带宽为共享实例出口地址 IP 的总和，一个 IP 是 200M	无硬性上限，建议根据所选资源规格的推荐值合理使用

前提条件

已注册火山引擎账号，并完成实名认证。

已在 API 网关的开服地域创建私有网络及其子网。如果您希望多可用区部署 API 网关，需提前在目标可用区下创建子网。详细操作，请参见创建私有网络。

如需使用监控功能，需完成以下准备工作：

开通托管 Prometheus（VMP）服务。

在您的 API 网关业务所在地域创建 Prometheus 工作区。

如需开启默认告警，请提前创建告警聚合策略和告警通知策略。

如需使用日志功能，需完成以下准备工作：

开通火山引擎日志服务 TLS。

已在 TLS 侧创建日志项目。API 网关支持自动创建默认日志主题，如需使用您自己的日志主题，请提前创建。具体操作可参见创建日志项目、创建日志主题。

使用限制

网关仅支持对接同一 VPC 内的云资源（例如：云服务器或容器服务），若需对接相关资源，请在目标资源所属的 VPC 下创建网关实例。

同一地域下，不同类型网关实例的可创建数量存在差异，详情参见使用限制。

操作步骤

在顶部导航栏，选择目标地域。

在左侧导航栏选择实例管理，在实例管理页面，单击创建实例或创建弹性型实例。

在创建实例页面，按要求配置实例信息。

基本信息

配置项	说明
地域	选择 API 网关业务所在的地域。当前支持的地域请参见地域和可用区。
网关类型	选择要创建的网关类型，创建后不支持切换网关类型。标准型网关：提供完整的网关功能，支持对接多种后端服务。弹性网关：实例资源被多用户共享，资源本身可根据业务使用情况进行资源的弹性扩容，无需感知资源底层负载。 Serverless 网关：对于火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。
实例名称	自定义 API 网关实例名称，同一账号下实例名称不允许重复。

规格配置

配置项	说明
节点规格	仅标准型网关支持。选择实例的对应节点的硬件配置。可根据业务需要，选择合适的节点规格。
节点数量	仅标准型网关支持。可根据业务需要，选择合适的节点数量。说明为了保证 API 网关的高可用，至少选择 2 节点。
私有网络	选择集群所属的私有网络（VPC）。私有网络为集群提供一个隔离的、自主配置和管理的虚拟网络环境。若无可用私有网络，可参考创建私有网络进行创建。注意网关实例需要与后端的 Upstream 资源（例如：云服务器、容器服务器集群等）属于相同 VPC。
可用区	可用区指同一地域内电力和网络互相独立的物理区域，不同可用区之间内网互通。为满足容灾需求，请至少选择两个可用区。勾选可用区后，需进一步选择目标可用区下的子网。选择子网时，系统会显示该子网的可用 IP 地址数目。说明请根据您的网络规划，选择合理的子网。子网 IP 数目过少，可能导致后续无法在该子网中创建云资源。 API 网关实例所在的子网，至少需要 2 个可用 IP 地址。
网络类型	选择网络类型。支持选择公网和私网。注意必须选择至少1个网络类型。不同的网络类型，对应不同的计费规则。公网计费请参见计费概述。 Serverless 网关默认开启公网类型，可选私网类型。创建完成后不支持通过更配变更网络类型。
CLB 规格	网关实例使用 CLB 作为网关的入口。对于标准网关，可根据业务需要，选择合适的 CLB 规格。规格参数如下：最大连接数：指一个 CLB 实例能够同时处理的最大连接数量。当实例上的连接超过规格定义的最大连接数时，新建连接请求将被丢弃。新建连接数（CPS）：指一个 CLB 实例能够承载的每秒新建连接的速率。当每秒新建连接的速率超过规格定义的新建连接数时，新建连接请求将被丢弃。每秒查询数（QPS）：指一个 CLB 实例每秒可以完成的 HTTP/HTTPS 的查询（请求）的数量。当查询速率超过规格定义的每秒查询数时，新建连接请求将被丢弃。带宽（Mbps）：指一个 CLB 实例在处理网络流量时，能够支持的最大数据传输速率。
公网网络计费	选择公网网络的计费方式。对于标准网关，支持以下两种计费方式：按带宽上限计费：按照您指定的带宽上限收费。平台会对您指定的带宽上限进行限速，请根据实际业务情况配置带宽上限。按实际流量计费：按照您出方向实际使用的流量进行计费。对带宽波动较大的业务场景来说，按实际流量计费比按带宽上限计费节省成本。

可观测性

说明

当前仅标准型网关和 Serverless 网关支持可观测性相关功能。

配置项	说明
监控告警	API 网关对接火山引擎的 VMP 服务，为您提供网关基础指标的免费监控和告警能力。如需使用监控告警功能，请勾选当前开关。 Prometheus 工作区：开启监控告警后必选配置。选择前提条件中准备的 Prometheus 工作区，网关当前实例下的所有监控数据会采集并存储在您绑定的 Prometheus 工作区下。警告绑定 Prometheus 工作区后不支持更改。删除 Prometheus 工作区可能会导致网关的监控数据永久丢失，请谨慎操作。
开启告警	是否开启默认告警通知。开启后，APIG 将提供默认告警用于监控您业务的稳定性。您可自定义修改告警规则，详细操作可参见托管 Prometheus 告警规则。告警聚合策略：开启告警后必选配置。选择前提条件中准备的告警聚合策略。告警聚合策略用来指定系统中的告警聚合周期和通知周期。告警通知策略：开启告警后可选配置。选择前提条件中准备的告警通知策略。告警通知策略用来指定不同等级的告警发生时，需要接收告警的告警联系人组。如不配置，则仅生成告警事件，不会发送告警通知。
日志服务	API 网关基于火山引擎日志服务 TLS，为您提供持久化存储的用户访问日志。如需使用日志功能，请勾选当前开关。注意日志服务由 TLS 提供，会产生费用，具体计费项参见产品计费。
日志项目	日志项目是日志服务中基础的资源管理单位，用于多用户或多项目、产品之间的日志资源隔离与访问控制。请选择目标日志项目。
日志主题	日志主题是日志服务进行日志管理的基本单位，每个日志主题用于承载同一应用中不同类型或不同分类的日志。默认配置：选择默认配置，网关将在当前项目下自动生成名称为网关 id-accessLog的主题。使用已有主题：选择使用已创建的日志主题。
链路追踪	是否开启 API 网关实例的链路追踪功能。开启后，需要选择链路追踪的后端服务。应用性能监控全链路版：使用 APMPlus 作为 API 网关实例链路追踪的后端服务。选择该选项时，需要配置： API Key：配置应用性能监控全链路版的 API Key。日志服务：使用 TLS 作为 API 网关实例链路追踪的后端服务。选择该选项时，需要配置：日志项目：选择日志服务中的日志项目。详情请参见日志项目。 Access Key ID：火山引擎账号的 AccessKey ID（AK）。获取方式，请参见访问密钥使用指南。 Secret Access Key：火山引擎账号的 Secret Access Key（SK）。获取方式，请参见访问密钥使用指南。

资源管理

选择 API 网关所属的资源项目（Project）。资源项目是火山引擎提供的一种资源分组管理的机制，帮助用户达成逻辑层面的资源隔离，您能够通过资源项目进行项目制授权和分账等操作。详情请参见项目管理。

配置完毕后，请仔细确认配置详情和订单费用。

确认无误后，请阅读《API 网关服务条款》并勾选同意。然后单击确认订单，开始创建网关实例。

结果验证

网关实例创建完成后，您可在实例管理页面查看已创建的网关实例，状态为运行中表明创建成功。

单击网关实例名称，进入实例详情页面，支持查看网关实例的概览信息、资源信息、监控信息、日志信息等。

最近更新时间：2026.09.10 15:36:47

这个页面对您有帮助吗？

有用

无用