使用 API 网关之前，首先需要创建资源相互隔离的网关实例。本文为您介绍如何创建一个 API 网关实例。 ## 背景信息 API 网关当前支持以下 2 种网关实例类型，如下表所示。 |网关类型 |说明 | |---|---| |标准网关 |提供完整的网关功能，支持对接多种后端服务。包括：容器服务、函数服务（veFaaS）、注册中心 Nacos、云服务器等。 | |Serverless 网关 |针对火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。其特点和使用限制如下：|\ | ||\ | |* 对接后端：仅支持对接火山引擎函数服务（veFaaS）。|\ | |* 计费：免除实例托管费用，收取 CLB 规格费用和公网网络费用。其中，公网网络费用仅支持按实际流量计费。|\ | |* 规格：不支持选择节点的规格和数量，CLB 规格仅支持小型 I。|\ | |* 配额：每个火山引擎账号在每个地域仅允许创建一个。 | ## 前提条件 * 已注册火山引擎账号，并完成实名认证。 * 已在 API 网关的开服地域创建私有网络及其子网。如果您希望多可用区部署 API 网关，需提前在目标可用区下创建子网。详细操作，请参见 [创建私有网络](https://www.volcengine.com/docs/6401/69467)。 * 如需使用监控功能，需完成以下准备工作： * 开通托管 Prometheus（VMP）服务。 * 在您的 API 网关业务所在地域 [创建 Prometheus 工作区](https://www.volcengine.com/docs/6731/106522)。 * 如需开启默认告警，请提前创建 [告警聚合策略](https://www.volcengine.com/docs/6731/159019) 和 [告警通知策略](https://www.volcengine.com/docs/6731/159013)。 * 如需使用日志功能，需完成以下准备工作： * 开通火山引擎日志服务 TLS。 * 已在 TLS 侧创建日志项目。API 网关支持自动创建默认日志主题，如需使用您自己的日志主题，请提前创建。具体操作可参见 [创建日志项目](https://www.volcengine.com/docs/6470/72005#%E5%88%9B%E5%BB%BA%E6%97%A5%E5%BF%97%E9%A1%B9%E7%9B%AE)、[创建日志主题](https://www.volcengine.com/docs/6470/72004#%E5%88%9B%E5%BB%BA%E6%97%A5%E5%BF%97%E4%B8%BB%E9%A2%98)。 ## 使用限制 * 网关仅支持对接同一 VPC 下的云服务器。如果您需要对接云服务器，请在目标云服务器所规划的 VPC 下创建网关实例。 * 网关仅支持对接同一 VPC 下的容器服务。如果您需要对接容器服务，请在目标集群所规划的 VPC 下创建网关实例。 ## 操作步骤 1. 登录 [API 网关控制台](https://console.volcengine.com/veapig)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧导航栏选择 **实例管理**，在实例管理页面，单击 **创建实例**。 4. 在创建实例页面，按要求配置实例信息。 * **基本信息** ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_06aede6fde65d9c68c22670297ac978d.png) |配置项 |说明 | |---|---| |地域 |选择 API 网关业务所在的地域。当前支持的地域请参见 [地域和可用区](https://www.volcengine.com/docs/6569/111925)。 | |网关类型 |选择要创建的网关类型，创建后不支持切换网关类型。|\ | ||\ | |* **标准网关**：提供完整的网关功能，支持对接多种后端服务。|\ | |* **Serverless 网关**：对于火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。 | |实例名称 |自定义 API 网关实例名称，同一账号下实例名称不允许重复。 | |备注 |配置 API 网关实例的备注信息，可以为空。 | * **规格配置** ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_91382cb22120ce873040285dabad8f10.png) |配置项 |说明 | |---|---| |节点规格 |对于标准网关，可根据业务需要，选择合适的节点规格。 | |节点数量 |对于标准网关，可根据业务需要，选择合适的节点数量。|\ | |:::tip|\ | |为了保证 API 网关的高可用，至少选择 2 节点。|\ | ||\ | |:::| |私有网络 |选择集群所属的私有网络（VPC）。私有网络为集群提供一个隔离的、自主配置和管理的虚拟网络环境。|\ | |若无可用私有网络，可参考 [创建私有网络](https://www.volcengine.com/docs/6401/69467) 进行创建。|\ | |:::warning|\ | |网关实例需要与后端的 Upstream 资源（例如：云服务器、容器服务器集群等）属于相同 VPC。|\ | ||\ | |:::| |可用区 |可用区指同一地域内电力和网络互相独立的物理区域，不同可用区之间内网互通。|\ | ||\ | |* 为满足容灾需求，请至少选择两个可用区。|\ | |* 勾选可用区后，需进一步选择目标可用区下的子网。选择子网时，系统会显示该子网的可用 IP 地址数目。|\ | ||\ | |:::tip|\ | ||\ | |* 请根据您的网络规划，选择合理的子网。子网 IP 数目过少，可能导致后续无法在该子网中创建云资源。|\ | |* API 网关实例所在的子网，至少需要 2 个可用 IP 地址。|\ | ||\ | |:::| |网络类型 |选择网络类型。支持选择 **公网** 和 **私网** 。|\ | |:::warning|\ | ||\ | |* 必须选择至少1个网络类型。|\ | |* 不同的网络类型，对应不同的计费规则。公网计费请参见 [产品计费](https://www.volcengine.com/docs/6569/185249#.5YWs572R6LS555So)。|\ | |* Serverless 网关默认开启 **公网** 类型，可选 **私网** 类型。|\ | |* 创建完成后不支持通过更配变更网络类型，如需变更请 [提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000170)。|\ | ||\ | |:::| |CLB 规格 |网关实例使用 CLB 作为网关的入口。对于标准网关，可根据业务需要，选择合适的 CLB 规格。 | |公网网络计费 |选择公网网络的计费方式。对于标准网关，支持以下两种计费方式：|\ | ||\ | |* **按带宽上限计费**：按照您指定的带宽上限收费。平台会对您指定的带宽上限进行限速，请根据实际业务情况配置带宽上限。|\ | |* **按实际流量计费**：按照您出方向实际使用的流量进行计费。对带宽波动较大的业务场景来说，按实际流量计费比按带宽上限计费节省成本。 | * **可观测性** ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b21397a32329f5909fd91cfe27377702.png =910x) |配置项 |说明 | |---|---| |监控告警 |API 网关对接火山引擎的 VMP 服务，为您提供网关基础指标的免费监控和告警能力。如需使用监控告警功能，请勾选当前开关。|\ | ||\ | |* **Prometheus 工作区**：开启监控告警后必选配置。选择前提条件中准备的 Prometheus 工作区，网关当前实例下的所有监控数据会采集并存储在您绑定的 Prometheus 工作区下。|\ | ||\ | |:::danger|\ | ||\ | |* 绑定 Prometheus 工作区后不支持更改。|\ | |* 删除 Prometheus 工作区可能会导致网关的监控数据永久丢失，请谨慎操作。|\ | ||\ | |:::| |开启告警 |是否开启默认告警通知。开启后，APIG 将提供默认告警用于监控您业务的稳定性。|\ | |您可自定义修改告警规则，详细操作可参见 [托管 Prometheus 告警规则](https://www.volcengine.com/docs/6731/159015)。|\ | ||\ | |* **告警聚合策略**：开启告警后必选配置。选择前提条件中准备的告警聚合策略。告警聚合策略用来指定系统中的告警聚合周期和通知周期。|\ | |* **告警通知策略**：开启告警后可选配置。选择前提条件中准备的告警通知策略。|\ | | 告警通知策略用来指定不同等级的告警发生时，需要接收告警的告警联系人组。如不配置，则仅生成告警事件，不会发送告警通知。 | |日志服务 |API 网关基于火山引擎日志服务 TLS，为您提供持久化存储的用户访问日志。如需使用日志功能，请勾选当前开关。|\ | |:::warning|\ | |日志服务由 TLS 提供，会产生费用，具体计费项参见 [产品计费](https://www.volcengine.com/docs/6470/111805)。|\ | ||\ | |:::| |日志项目 |日志项目是日志服务中基础的资源管理单位，用于多用户或多项目、产品之间的日志资源隔离与访问控制。请选择目标日志项目。 | |日志主题 |日志主题是日志服务进行日志管理的基本单位，每个日志主题用于承载同一应用中不同类型或不同分类的日志。|\ | ||\ | |* **默认配置**：选择默认配置，网关将在当前项目下自动生成名称为`网关 id-accessLog`的主题。|\ | |* **使用已有主题**：选择使用已创建的日志主题。 | |链路追踪 |是否开启 API 网关实例的链路追踪功能。开启后，需要选择链路追踪的后端服务。|\ | ||\ | |* **应用性能监控全链路版**：使用 APMPlus 作为 API 网关实例链路追踪的后端服务。选择该选项时，需要配置：|\ | | * API Key：配置应用性能监控全链路版的 API Key。|\ | |* **日志服务**：使用 TLS 作为 API 网关实例链路追踪的后端服务。选择该选项时，需要配置：|\ | | * **日志项目**：选择日志服务中的日志项目。详情请参见 [日志项目](https://www.volcengine.com/docs/6470/72005)。|\ | | * **Access Key ID**：火山引擎账号的 AccessKey ID（AK）。获取方式，请参见 [访问密钥使用指南](https://www.volcengine.com/docs/6291/65568)。|\ | | * **Secret Access Key**：火山引擎账号的 Secret Access Key（SK）。获取方式，请参见 [访问密钥使用指南](https://www.volcengine.com/docs/6291/65568)。 | * **资源管理** 选择 API 网关所属的资源项目（Project）。资源项目是火山引擎提供的一种资源分组管理的机制，帮助用户达成逻辑层面的资源隔离，您能够通过资源项目进行项目制授权和分账等操作。详情请参见 [项目管理](https://www.volcengine.com/docs/6649/94336)。 5. 配置完毕后，请仔细确认配置详情和订单费用。 6. 确认无误后，请阅读《API 网关服务条款》并勾选同意。然后单击 **确认订单**，开始创建网关实例。 ## 结果验证网关实例创建完成后，您可在实例管理页面查看已创建的网关实例，状态为 **运行中** 表明创建成功。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_050753f27cfaa2a74a59963ee2103604.png =971x) 单击网关实例名称，进入实例详情页面，支持查看网关实例的概览信息、资源信息、监控信息、日志信息等。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_df7359701dd3fe92982a9de7663b3e1f.png =972x)