You need to enable JavaScript to run this app.
导航

创建实例

最近更新时间2023.11.23 11:52:18

首次发布时间2022.01.07 19:21:45

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

前提条件

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

使用限制

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

操作步骤

  1. 登录 API 网关控制台

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

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

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

    • 基本信息
    配置项说明
    实例名称自定义 API 网关实例名称,同一账号下实例名称不允许重复。
    地域选择您 API 网关业务所在的地域。当前支持的地域请参见 地域和可用区
    备注输入当前网关实例的备注信息,可以为空。
    • 规格配置
    配置项说明
    节点规格根据业务需要,选择合适的节点规格。

    节点数量

    根据业务需要,选择合适的节点数量。

    说明

    为了保证 API 网关的高可用,至少选择 2 节点。

    CLB 规格网关实例使用 CLB 作为网关的入口。请根据业务需要,选择合适的 CLB 规格。

    公网网络计费

    选择公网网络的计费方式。

    • 按带宽上限计费:按照您指定的带宽上限收费。平台会对您指定的带宽上限进行限速,请根据实际业务情况配置带宽上限。
    • 按实际流量计费:按照您出方向实际使用的流量进行计费。对带宽波动较大的业务场景来说,按实际流量计费比按带宽上限计费节省成本。

    私有网络

    选择您在前提条件中准备好的私有网络 VPC。

    注意

    • 如果网关需要对接云服务器,需选择目标云服务器所处的 VPC。
    • 如果网关需要对接容器服务,需选择目标集群所处的 VPC。

    可用区

    可用区指同一地域内电力和网络互相独立的物理区域,不同可用区之间内网互通。
    API 网关支持多可用区部署,满足容灾需求。当前最多支持选择两个可用区。
    勾选可用区后,需进一步选择目标可用区下的子网。

    • 后端信息
    配置项说明

    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 服务,为您提供观测 API 网关性能指标的能力。如需使用监控告警功能,请打开当前开关。
    Prometheus 工作区:选择前提条件中创建的 VMP workspace,将其绑定至 API 网关。

    警告

    • 绑定 VMP workspace 后不支持更改。
    • API 网关当前实例下的所有监控数据会采集并存储在您绑定的 VMP workspace 下。删除 workspace 可能会导致网关的监控数据永久丢失,请谨慎操作。
  5. 配置完毕后,请仔细确认配置详情和订单费用。

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

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

后续操作

创建服务