文档中心

API 网关

快速入门

使用 API 网关发布云服务器中部署的应用

API 网关支持对接云服务器 ECS，为云服务器内的应用提供高可用的网关功能。本文以部署在云服务器中的 Nginx 应用为例，介绍如何通过 API 网关发布部署在云服务器中的应用。

背景信息

API 网关（API Gateway，APIG）为云服务器提供托管的云原生网关功能，实现高可用、高扩展的 Ingress 流量管理方式。同时，API 网关支持对接托管 Prometheus 产品，实现实例级别、服务级别的观测和告警。

前提条件

已购买云服务器，详情请参见购买方式概述。

已在云服务器中部署应用，并开放对应端口。本例中以 Nginx 应用，80 端口为例。

已创建托管 Prometheus 工作区，详情请参见创建工作区。

已在域名注册商处获取待绑定的域名，并在工信部完成 ICP 备案或接入备案。详情请参见备案流程。

操作步骤

步骤一：创建实例

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

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

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

基本信息：选择标准网关类型，并配置网关实例的名称，本例中为 apig-demo。

规格配置：配置网关实例的规格、私有网络等信息。其中，私有网络必须与 VKE 集群的保持一致。

可观测性：开启监控告警，并选择托管 Prometheus 工作区。

其他配置保持缺省，阅读《API 网关服务条款》并勾选同意。

单击确认订单，开始创建网关实例。

步骤二：创建服务

在左侧导航栏选择路由管理 > 服务列表（域名）。单击创建服务。

在创建服务对话框，配置服务名称和所属实例。

单击确定，完成服务配置。

步骤三：绑定自定义域名

在服务列表中单击目标服务名称，进入服务概览页面。

选择域名管理页签，单击绑定域名，在服务中配置自定义域名和协议。

说明

公网域名需要在工信部完成 ICP 备案或接入备案，本文中的域名仅为示例。

您需要自主保证自定义域名和 API 网关 IP 地址的 DNS 解析关系，以保证能够通过域名正常访问到 API 网关实例。

单击确定，完成域名绑定。

步骤四：创建 Upstream

在左侧导航栏选择后端管理 > Upstream 列表。

在 Upstream 列表页面，单击创建 Upstream。

在创建 Upstream 页面，按要求填写参数信息。

基本信息：配置 Upstream 的名称和所属实例。

后端配置：后端服务选择云服务器。

单击点击添加，在弹出的配置页面中选择 ECS 实例，并配置服务端口。

单击确定，完成创建云服务器类型 Upstream。

步骤五：创建路由

说明

系统支持为指定服务配置单条路由，也支持为多个服务批量创建路由。本文以指定服务配置单条路由为例。

为多个服务批量创建路由的操作方法，请参见创建路由。

在左侧导航栏选择路由管理 > 服务列表（域名）。

在服务列表页面，单击目标服务名称，进入当前服务概览页面。

单击创建路由，配置路由信息。

基本信息：配置路由的名称、请求方法 Method 和路径 Path。

Upstream 流量分发：在后端类型下拉菜单中选择云服务器，并选择已配置好的 Upstream。配置权重为 100，表示将 100% 的流量都转发到该后端。

单击确定，创建完成路由。

步骤六：配置安全组

登录私有网络控制台。

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

在左侧导航栏选择安全组，在安全组列表中找到 ECS 实例所属安全组。单击安全组名称，进入安全组详情页。

选择访问规则 > 入向规则页签，单击添加规则，放行 APIG 安全组（命名为apig-sg-<accountID>），确保网关可以正常访问 ECS 对应端口中的资源。

单击确定，完成配置。

结果验证

访问应用

在本地环境中，使用如下命令访问应用。

预期访问结果如下。表示可以通过自定义域名访问到部署在云服务器中的应用。

查看监控信息

在左侧导航栏选择实例管理，单击目标实例名称，进入实例概览页面。

单击监控信息，切换至监控信息页签。

设置查询时间范围，查看当前实例的各项监控指标。最多支持查看近 30 天的监控数据。

最近更新时间：2025.02.13 14:30:31

这个页面对您有帮助吗？

有用

无用