创建实例

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

背景信息

API 网关当前提供以下两种网关实例类型：

• 标准网关
  提供完整的网关功能，支持对接多种后端服务。
• Serverless 网关
  对于火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。Serverless 网关特点如下：
  • 对接后端：仅支持对接火山引擎函数服务（veFaaS）。
  • 计费：免除实例托管费用，收取 CLB 规格费用和公网网络费用。其中，公网网络费用仅支持按实际流量计费。
  • 规格：不支持选择节点的规格和数量，CLB 规格仅支持小型I。
  • 配额：每个火山引擎账号在每个地域仅允许创建一个。

前提条件

• 已注册火山引擎账号，并完成实名认证。
• 已在 API 网关的开服地域创建私有网络及其子网。如果您希望多可用区部署 API 网关，需提前在目标可用区下创建子网。详细操作，请参见 创建私有网络。
• 已提前准备好待对接的后端服务，API 网关当前支持对接火山引擎的 函数服务、云服务器 及 容器服务。
• 对接容器服务的 Flannel 集群，需完成以下准备工作：
  1. 该功能当前为白名单功能，如需体验，请 提交工单 申请。
  2. 准备待对接 Flannel 集群的 Pod CIDR。您可登录容器服务控制台，在目标集群页面的 基本信息 > 网络信息 页签下查看 Pod CIDR 信息。
• 如需使用监控功能，需完成以下准备工作：
  • 开通托管 Prometheus 服务（VMP 服务）。
  • 在您的 API 网关业务所在地域 创建 Prometheus 工作区。
  • 如需开启默认告警，请提前创建 告警聚合策略 和 告警通知策略。
• 如需使用日志功能，需完成以下准备工作：
  • 开通火山引擎日志服务 TLS。
  • 提前在 TLS 侧创建日志项目。API 网关支持自动创建默认日志主题，如需使用您自己的日志主题，请提前创建。具体操作可参见 创建日志项目、创建日志主题。

使用限制

• 网关仅支持对接同一 VPC 下的云服务器。如果您需要对接云服务器，请在目标云服务器所规划的 VPC 下创建网关实例。
• 网关仅支持对接同一 VPC 下的容器服务。如果您需要对接容器服务，请在目标集群所规划的 VPC 下创建网关实例。

操作步骤

1. 登录 API 网关控制台。

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

3. 在左侧导航栏选择 实例管理，在实例管理页面，单击 创建实例。

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

   • 基本信息

   

   配置项	说明
   地域	选择您 API 网关业务所在的地域。当前支持的地域请参见 地域和可用区。
   网关类型	选择要创建的网关类型。创建后不支持切换网关类型。 标准网关：提供完整的网关功能，支持对接多种后端服务。 Serverless 网关：对于火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。
   实例名称	自定义 API 网关实例名称，同一账号下实例名称不允许重复。
   备注	输入当前网关实例的备注信息，可以为空。

   • 规格配置

   

   配置项	说明
   节点规格	对于标准网关，可根据业务需要，选择合适的节点规格。
   节点数量	对于标准网关，可根据业务需要，选择合适的节点数量。 说明 为了保证 API 网关的高可用，至少选择 2 节点。
   CLB 规格	网关实例使用 CLB 作为网关的入口。对于标准网关，可根据业务需要，选择合适的 CLB 规格。
   公网网络计费	选择公网网络的计费方式。对于标准网关，支持以下两种计费方式： 按带宽上限计费：按照您指定的带宽上限收费。平台会对您指定的带宽上限进行限速，请根据实际业务情况配置带宽上限。 按实际流量计费：按照您出方向实际使用的流量进行计费。对带宽波动较大的业务场景来说，按实际流量计费比按带宽上限计费节省成本。
   私有网络	选择您在前提条件中准备好的私有网络 VPC。 注意 如果网关需要对接云服务器，需选择目标云服务器所处的 VPC。 如果网关需要对接容器服务，需选择目标集群所处的 VPC。
   可用区	可用区指同一地域内电力和网络互相独立的物理区域，不同可用区之间内网互通。 为满足容灾需求，请至少选择两个可用区。 勾选可用区后，需进一步选择目标可用区下的子网。

   • 后端信息

   

   配置项

   说明

   Flannel 容器集群

   容器服务支持 Flannel 和 VPC-CNI 两种网络类型的集群。当 API 网关需要对接容器服务的 Flannel 集群时，需打开该开关。 集群 Pod CIDR：为避免 API 网关所在集群的网络与您的 Flannel 集群网络发生冲突，需在此处选择待对接 Flannel 集群的 Pod CIDR 所属网段。后续添加 Flannel 集群为服务来源时，所选集群的 Pod CIDR 必须与此处设置的一致。 例如：待对接 Flannel 集群的 Pod CIDR 为192.168.0.0/18，属于 192 网段，则此处选择192.168.0.0/16。 说明 对接 Flannel 集群为白名单功能，请 提交工单 申请。 您可登录容器服务控制台，在目标集群页面的 基本信息 > 网络信息 页签下查看 Pod CIDR 信息。 一个 API 网关对接多个 Flannel 集群时，仅支持选择 Pod CIDR 属于同一网段的 Flannel 集群。

   • 可观测性

   

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

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

6. 确认无误后，请阅读《API 网关服务条款》并勾选同意。

7. 单击 确认订单，开始创建网关实例。
   您可在实例管理页面查看已创建的网关实例，状态为 运行中 表明创建成功。

后续操作

创建服务