参考信息 › 应用目录参考指南 › Web 服务应用 › WS_API_SAMPLE－Web 服务 API 示例应用

WS_API_SAMPLE－Web 服务 API 示例应用

最新版本：1.0.3-1

只有 CA AppLogic 2.9 正式版及后续版本才提供 Web 服务 API。

WS_API_SAMPLE 应用提供如何生成简单门户应用（此应用访问 CA AppLogic Web 服务 API 应用，即 WS_API）的示例。 此应用用于为门户和应用的开发者提供指南，所述门户和应用向 CA AppLogic 网格上运行的 WS_API 应用实例发出 Web API 请求。

CA AppLogic Web 服务“WS_API_SAMPLE”应用边界属性

重要信息！ vpn_out_ip、in_usr_ip 和 net_out_ip 属性中配置的 IP 地址必须是您的 CA AppLogic 网格上可使用的 IP 地址。 您可能会在您的网格显示板上发现这些地址以及网络掩码、网关和 DNS 服务器。 我们正在努力使 CA AppLogic 能自动提供这些地址。

应用资源

应用卷

BackupHelper 应用包括以下卷：

实施详细信息

应用体系结构

BackupHelper 包含以下组件：

• 一个有防火墙的输入网关
• 一个 Web 服务器
• 一个内容文件服务器
• 一个有防火墙的网络输出网关

概览

需要对 WS_API_SAMPLE 应用进行配置，以访问运行在 CA AppLogic 网格上的 WS_API 的实例。 在启动此应用之前，按如下说明启动 WS_API 应用的实例。 然后根据 WS_API 应用实例中设置的属性对 WS_API_SAMPLE 进行配置。

配置 WS_API_SAMPLE

1. 编辑位于应用门户卷 bin 子目录中的门户脚本，并将脚本中的 IP 变量设置为：
2. 将 IP 变量设置为 usr_ip，向 WS_API 应用发送基于 HTTP 或 HTTP 的请求，或将其设置为 aux，通过 VPN 通道发送基于 HTTP 的请求
3. 编辑 VDC 信息，使其匹配 WS_API 应用上的 vdcs.conf。 E.g -

   # EDIT VDC info here
   <p>
   <label for="location">Select Location: </label>
   <select name="location">
   <option value="dallas">Dallas, TX, USA</option>
   <option value="sandiego">San Diego, CA, USA</option>
   <option value="japan">Tokyo, Japan</option>
   <option value="netherlands">Amsterdam, Netherlands</option>
   </select>
   </p>
   上面的内容应改为在 WS_API 应用中配置的 VDC。 如果 mygrid1 和 mygrid2 是分别在 Dallas 和 San Diego 运行的两个 VDC，则以上 HTML 代码应改为： 
   # EDIT VDC info here
   <p>
   <label for="location">Select Location: </label>
   <select name="location">
   <option value="mygrid1">Dallas, TX, USA</option>
   <option value="mygrid2">San Diego, CA, USA</option>
   </select>
   </p>
   

WS_API_SAMPLE 可配置为使其以下模式之一运行：

• HTTP
• HTTPS
• VPN 通道

使用 HTTP

在此模式下，门户使用基于常规 HTTP 的接口向 WS_API 应用实例发送 API 请求。
例如，curl "http://usr_ip/api/v1/app/list?vdc=mygrid1"。

使用 HTTPS

在此模式下，门户使用基于安全 HTTP 的接口，即 HTTPS，向 WS_API 应用实例发出 API 请求。 要使用它，应将 api_client.pem 密钥复制到 WS_API_SAMPLE 应用门户卷的密钥子目录中。
例如，curl -k -E /mnt/fs/keys/api_client.pem "https://usr_ip/api/v1/app/list?vdc=mygrid1"。

使用 VPN 通道

在此模式下，门户使用基于常规 HTTP 的接口通过安全 VPN 通道向 WS_API 应用实例发送 API 请求。 要创建隧道，仅需要将 WS_API 应用实例 vpn_key 卷的 server 子目录中生成的 client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt 和 ca.crt 文件复制到 WS_API_SAMPLE 应用实例 vpn_key 卷的 client 子目录中。 一旦启动 out_vpn 组件就会创建安全通道。
例如，curl "http://aux/api/v1/app/list?vdc=mygrid1"。

要通过 Web 浏览器访问门户，将浏览器指向 http://in_usr_ip/api/portal

应用体系结构

CA AppLogic Web 服务“WS_API_SAMPLE”应用基础架构显示如下：

它包含以下组件：

• 一个有防火墙的输入网关－支持基于 HTTP 和 HTTPS 访问门户
• 一个 VPN 客户端－通过安全通道向 WS_API 应用中的 VPN 服务器发出 API 请求
• 一个有防火墙的网络网关－向 WS_API 应用的 usr_ip 发出基于 HTTP 和 HTTPS 的 API 请求
• Web 服务器－运行示例门户
• Linux 组件－根据请求发出命令行
• 集中式配置文件存储

说明

使用的开源软件和第三方软件

下面的第三方开源软件已安装在门户卷上。