部署 API 实例

要部署 API 实例,您需要一个 API 代理。API 代理是前端虚拟服务器,其中 API 网关(ADC 实例)接收来自 API 客户端的 API 流量。API 客户端可以是浏览器、移动应用程序等。

您可以与不同的 API 部署共享 API 代理。在拥有多个 API 服务的组织中,您可以为每个 API 服务创建单独的 API 代理。或者,您可以创建一个 API 代理并将其与不同 API 服务的 API 实例共享。

例如,两个 API 服务 app1app2 部署在同一 API Gateway 上,使用相同的前端虚拟服务器。您想为两个 API 服务提供相同的虚拟 IP 地址和 SSL 证书信息。在这种情况下,您可以添加具有所需信息的 API 代理,并与单独的部署共享。因此,不同部署上的 API 服务可以使用共享 API 代理接收请求。

作为管理员,执行以下操作来部署 API 实例:

  1. 添加 API 代理
  2. 使用 API 代理部署 API 实例

添加 API 代理

按照以下步骤添加 API 代理:

  1. 前往“安全”>“API 安全”>“API 代理”。

  2. 指定以下内容:

    • 代理名称 — API 代理的名称。

    • 目标 API 网关 -选择充当 API 网关的 ADC 实例。

    • IP 地址 -托管 API 服务的虚拟服务器的 IP 地址。

    • 端口 -托管 API 服务的虚拟服务器的端口号。

    • 协议 -根据您要在 API 代理上接收的流量类型(HTTP 或 HTTPS)设置协议。

    • TLS 安全配置文件 -从列表中选择高或中。如果您选择“高”,它将映射到 ADC 实例上的 A+ 评级 SSL 配置文件。

    • 证书存储 -为 API 网关选择 SSL 证书。NetScaler ADM 代理证书存储库可帮助您在一个位置存储和管理 SSL 证书。

      NetScaler ADM 证书存储区

      在 NetScaler ADM 代理证书存储库中,您可以将 SSL 证书存储在 NetScaler ADM 代理中,然后在 ADC 配置期间重复使用它们。

      注意

      当您的现有部署使用不在 {page.adm-ads-agent-short}} 证书存储区中的 SSL 证书或密钥时,请使用相同名称将证书和密钥添加到存储中。

    • 服务 FQDN -托管 API 服务的完全限定域名。例如: api.example.com

    或者,您可以选择 IPAM 网络来分配 IP 地址。要查看从 IPAM 网络分配的 IP 地址,请导航到 设置 > IPAM。有关 IPAM 的更多信息,请参阅 配置 IPAM

  3. 单击 保存 以保存部署配置。

    如果您想在 API 网关上部署此 API 代理,请单击“保存并部署”。

API 代理

添加 API 代理后,部署 API 实例。

使用 API 代理部署 API 实例

按照以下步骤部署 API 实例:

  1. 导航到 安全 > API 安全 > 部署

  2. 单击添加

  3. 在“部署基本 信息”中,

    1. 指定 部署名称

    2. API 定义中,选择所需的 API 定义。

    3. 选择要用于此部署的 API 代理

  4. 在“上游服务”中,单击“ 加”以添加要将 API 流量输出 API 流量的后端(源)API 服务器。您可以使用其域名或 IP 地址配置上游服务。

    在部署 API 实例时,您可以指定 SNIP 地址和网络掩码详细信息。ADC 实例使用指定的 SNIP 地址与上游服务(后端)通信。指定的 SNIP 地址成为发送到上游服务的出口流量的源 IP 地址。您也可以使用 IPAM 配置 SNIP 地址和网络掩码。如果您未配置 SNIP 地址,则 ADC 实例的默认 SNIP 地址将成为上游服务的源 IP 地址。

    注意

    默认情况下,SNIP 地址和网络掩码选项是可选的。但是,如果您指定其中一个选项,则还必须指定另一个选项。

    1. 为上游服务指定一个名称。

    2. 指定域。

    3. 服务中,指定 IP 地址和端口值。要添加更多 IP 地址,请单击“添加新行”。

    4. 单击添加

  5. 路由中,指定以下详细信息以根据资源路径前缀路由传入的 API 流量:

    1. 指定路径名称。

    2. 选择一个 API 资源 来接收 API 请求。

      注意

      您也可以指定自定义路径或路径前缀。

    3. 从列表中选择要在其中传输 API 流量的 上游服务

  6. 单击 保存 以保存部署配置。

    如果要将配置部署到 API 网关,请单击“保存并部署”。

API 部署

启用 API 分析

以下是为部署启用分析的先决条件:

  • 确保虚拟服务器已获得许可

  • 确保分析状态为“已禁用

  • 确保虚拟服务器处于运行状态

要为部署启用 API 分析,请执行以下操作:

  1. 选择要启用 API 分析的部署。

  2. 单击 启用分析

    为 API 部署启用分析

  3. 为部署配置 Analytics 页面中,选择虚拟服务器,然后单击 启用 Analytics

    为 API 部署配置分析

  4. 启用分析 窗口中:

    1. 选择洞察类型(Web Insight、Security Insight、机器人洞察)

    2. 选择 LogstreamIPFIX 作为传输模式。

      有关 IPFIX 和 Logstream 的更多信息,请参阅 Logstream 概述

    3. 默认情况下,表达式为真。

    4. 单击确定

    启用 API 分析

NetScaler ADM 处理以在选定的虚拟服务器上启用分析。

部署 API 实例