部署一个API实例
要部署API实例,需要API代理。API代理是一个前端虚拟服务器,API网关(ADC实例)在这里接收来自API客户端的API流量。API客户端可以是浏览器、移动应用程序等等。
您可以与不同的API部署共享一个API代理。在拥有多个API服务的组织中,可以为每个API服务创建单独的API代理。或者,您可以为不同的API服务创建并共享API代理与API实例。
例如,这两个API服务app1
而且app2
部署在同一个API Gateway上,使用同一个前端虚拟服务器。您希望向两个API服务提供相同的虚拟IP地址和SSL证书信息。在这种情况下,您可以添加具有所需信息的API代理,并与单独的部署共享。因此,不同部署上的API服务可以使用共享API代理接收请求。
管理员部署API实例的操作如下:
添加API代理
按照以下步骤添加API代理:
去安全> API网关> API代理.
指定以下内容:
代理名称—API代理的名称。
目标API网关—选择作为API网关的ADC实例。
IP地址—承载API服务的虚拟服务器的IP地址。
港口—承载API服务的虚拟服务器的端口号。
协议—根据您希望在API代理上接收的流量类型(HTTP或HTTPS)设置协议。
TLS安全配置文件—在列表中选择“高”或“中”。如果选择High,它将映射到ADC实例上的A+级SSL配置文件。
证书存储—选择API网关的SSL证书。Citrix ADM代理证书存储可帮助您在一个位置存储和管理SSL证书。
在Citrix ADM代理证书存储中,可以将SSL证书存储在Citrix ADM代理中,并在配置ADC时重用。
请注意
当您现有的部署中使用的SSL证书或密钥不在{页。Adm-ads-agent-short}}证书库,将证书和密钥添加到同名证书库中。
服务FQDN-你的API服务托管的完全限定域名。例如:
api.example.com
也可以选择IPAM网络来分配IP地址。如果需要查看IPAM网络中已分配的IP地址,可跳转到> IPAM设置.有关IPAM的更多信息,请参见配置IPAM.
点击保存保存部署配置。
如果需要在API网关上部署该API代理,单击保存和部署.
添加API代理后,需要部署API实例。
使用API代理部署API实例
按照以下步骤部署API实例:
导航到安全> API网关>部署.
点击添加.
在部署基本信息,
指定部署的名字.
在API定义,选择所需的API定义。
选择API代理您希望在此部署中使用的。
在上游的服务,点击添加添加后端(源)API服务器,您希望在其中出口API流量。上行服务可以通过域名或IP地址进行配置。
您可以在部署API实例时指定SNIP地址和子网掩码详细信息。ADC实例使用指定的SNIP地址与上游服务(后端)通信。指定的SNIP地址作为发送到上游业务的出接口流量的源IP地址。也可以使用IPAM配置SNIP地址和netmask。如果不配置SNIP地址,则上行业务的源IP地址为ADC实例的默认SNIP地址。
请注意
缺省情况下,SNIP地址和netmask为可选选项。但是,如果指定了其中一个选项,则还必须指定另一个选项。
指定上游服务的名称。
指定域。
在服务,指定IP地址和端口号。单击,可继续添加IP地址添加新行.
点击添加.
在路由,根据资源路径前缀指定以下详细信息来路由传入的API流量:
指定路由名。
选择一个API的资源接收API请求。
请注意
也可以指定自定义路径或路径前缀。
选择一个上游的服务从你想要传输API流量的列表中。
点击保存保存部署配置。
如果需要将配置部署到API网关,单击保存和部署.
启用API分析
以下是为部署启用分析的先决条件:
确保虚拟服务器处于正常状态许可
确保分析状态为禁用
确保虚拟服务器在向上状态
要为部署启用API分析,请执行以下操作:
选择要对其启用API分析的部署。
点击使分析.
在为部署配置Analytics页,选择虚拟服务器,单击使分析.
在使分析亮点:
选择洞察类型(Web insight, Security insight, Bot insight)
选择Logstream或IPFIX作为传输模式。
有关IPFIX和Logstream的详细信息,请参见Logstream概述.
表达式默认为true。
点击好吧.
Citrix ADM进程在选定的虚拟服务器上启用分析。