Tema anterior: WS_API: aplicación API de servicios Web

Tema siguiente: Aplicaciones del sistema

WS_API_SAMPLE: aplicación de muestra de API de servicios Web

Última versión: 1.0.1-1

La API de servicio Web sólo está disponible en la versión de producción de CA 3Tera AppLogic 2.9 y en versiones posteriores.

La aplicación WS_API_SAMPLE ofrece un ejemplo de cómo generar una aplicación de portal sencilla que acceda a la aplicación API de servicio Web de CA 3Tera AppLogic, es decir, WS_API. Esta aplicación se proporciona para guiar a los desarrolladores de portales y aplicaciones que envían solicitudes API de Web a una instancia de la aplicación WS_API que se ejecuta en un grid de CA 3Tera AppLogic.

Propiedades de límite de la aplicación 'WS_API_SAMPLE' de servicios Web de CA 3Tera AppLogic

Nombre de la propiedad

Tipo

Descripción

in_usr_ip

IP

Es la dirección IP en la cual un usuario puede acceder al portal de WS_API_SAMPLE. Esta propiedad es obligatoria.

net_out_ip

IP

Es la dirección IP que la aplicación WS_API_SAMPLE utiliza para emitir solicitudes basadas en HTTP o HTTPS a la aplicación WS_API. Esta propiedad es obligatoria.

vpn_out_ip

IP

Esta es la dirección IP que la aplicación WS_API_SAMPLE utiliza para emitir solicitudes basadas en HTTP a la aplicación WS_API a través de un túnel VPN seguro. Esta propiedad es obligatoria.

netmask

IP

Máscara de red para la red en la que residen vpn_out_ip, in_usr_ip y net_out_ip. Esta propiedad es obligatoria.

gateway

IP

Dirección de la puerta de enlace IP que se utilizará para enrutar tráfico. Esta propiedad se deberá especificar para acceder a la aplicación WS_API. Esta propiedad es obligatoria.

dns1

IP

Dirección IP de un servidor DNS para resoluciones de nombre de host. Esta propiedad es obligatoria.

dns2

IP

Dirección IP de un servidor DNS de copia de seguridad para resoluciones de nombre de host. Valor predeterminado: 0.0.0.0.

api_ports

Cadena

Lista de puertos separados por comas en los cuales se puede acceder a la aplicación WS_API_SAMPLE. Valor predeterminado: vacío

allowed_hosts

Cadena

Dirección IP o intervalo de direcciones IP en formato CIDR permitidas que puede acceder a WS_API_SAMPLE. Valor predeterminado: 0.0.0.0/0; (se permite todo)

Importante: Las direcciones IP configuradas en las propiedades vpn_out_ip, in_usr_ip y net_out_ip deben ser direcciones IP disponibles en el grid de CA 3Tera AppLogic. Puede encontrarlas, junto con la máscara de red, la puerta de enlace y los servidores DNS, en el cuadro de mandos del grid. Estamos trabajando para hacer posible que CA 3Tera AppLogic proporcione estas direcciones automáticamente.

Recursos de la aplicación

Recursos

Mín.

Máx.

Predeterminado

CPU

0,45

72

1,05

Memoria

448 MB

132 GB

1,25 GB

Banda ancha

6 Mbps

12 Gbps

1,51 G

Volúmenes de aplicación

La aplicación utiliza varios volúmenes. Forman parte de la aplicación y ya están configurados en las instancias del dispositivo. No hay ningún volumen que se tenga que configurar en el límite de la aplicación.

Volumen

Tamaño

Descripción

portal

50 M

Este volumen se utiliza para almacenar los scripts y el código de la aplicación de muestra (además de todo lo que necesite la aplicación). Este volumen se asigna al dispositivo NAS. De forma predeterminada, se proporciona un volumen lleno denominado 'data' para que lo utilice esta aplicación.

vpn_key

65 M

Este volumen se utiliza para almacenar datos clave de vpn para la aplicación. Los archivos client.* y ca.crt creados por el dispositivo VPN en una instancia de la aplicación WS_API se deberían almacenar en el subdirectorio del cliente de este volumen.

mon

50 M

Este volumen se utiliza para almacenar datos de monitorización de la aplicación. No existe ningún motivo para que el usuario acceda/modifique este volumen; el dispositivo MON utiliza este volumen internamente. De forma predeterminada, se proporciona un volumen denominado 'mon' para almacenar los datos de monitorización de la aplicación.

Operación

Descripción general

La aplicación WS_API_SAMPL tiene que configurarse para acceder a la instancia de WS_API que se ejecuta en un grid de CA 3Tera AppLogic. Antes de iniciar esta aplicación, inicie una instancia de la aplicación WS_API tal y como se explica aquí. A continuación, se puede configurar WS_API_SAMPLE con respecto a las propiedades que están establecidas en la instancia de la aplicación WS_API.

Cómo configurar WS_API_SAMPLE

  1. Edite el script del portal que reside en el subdirectorio bin del volumen del portal de la aplicación y establezca la variable IP en el script de la siguiente manera:
  2. Establezca la variable IP como usr_ip, para emitir las solicitudes basadas en HTTP o HTTPS a la aplicación WS_API, o como aux, para emitir solicitudes basadas en HTTP mediante un túnel VPN
  3. Edite la información VDC para que coincida con el valor de vdcs.conf en la aplicación WS_API. Por ejemplo:
    # EDIT VDC info here
    <p>
    <label for="location">Seleccionar ubicación: </label>
    <select name="location">
    <option value="dallas">Dallas, TX, EE. UU.</option>
    <option value="sandiego">San Diego, CA, EE. UU.</option>
    <option value="japan">Tokio, Japón</option>
    <option value="netherlands">Ámsterdam, Países Bajos</option>
    </select>
    </p>
    Lo anterior se debería cambiar a las aplicaciones SDV que se configuran en la aplicación WS_API. Si mygrid1 y mygrid2 son dos aplicaciones SDV que se ejecutan en Dallas y en San Diego respectivamente, el código HTML anterior debería cambiarse de la siguiente manera: 
    # EDIT VDC info here
    <p>
    <label for="location">Seleccionar ubicación: </label>
    <select name="location">
    <option value="mygrid1">Dallas, TX, EE. UU.</option>
    <option value="mygrid2">San Diego, CA, EE. UU.</option>
    </select>
    </p>
    

Se puede configurar WS_API_SAMPLE para que funcione en uno de los modos siguientes:

Uso de HTTP

En este modo, el portal utilizar una interfaz basada en HTTP normal para emitir solicitudes API a la instancia de la aplicación WS_API.
Por ejemplo, curl "http://usr_ip/api/v1/app/list?vdc=mygrid1".

Uso de HTTPS

En este modo, el portal utilizar una interfaz basada en HTTP seguro, es decir HTTPS, para emitir solicitudes API a la instancia de la aplicación WS_API. Para que esto funcione, la clave api_client.pem se debería copiar al subdirectorio de claves del volumen del portal de la aplicación WS_API_SAMPLE.
Por ejemplo, curl -k -E /mnt/fs/keys/api_client.pem "https://usr_ip/api/v1/app/list?vdc=mygrid1".

Uso del túnel VPN

En este modo, el portal utilizar una interfaz basada en HTTP normal para emitir solicitudes API a la instancia de la aplicación WS_API a través de un túnel VPN seguro. Para crear el túnel, tan solo hay que copiar los client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt y ca.crt generados en el subdirectorio del servidor del volumen vpn_key de la instancia de la aplicación WS_API al subdirectorio de cliente del volumen vpn_key de la aplicación WS_API_SAMPLE. Se crea un túnel seguro en cuanto se inicia el componente out_vpn.
Por ejemplo, curl "http://aux/api/v1/app/list?vdc=mygrid1".

Para acceder al portal a través de un explorador Web, apunte el explorador a http://in_usr_ip/api/portal

Arquitectura de la aplicación

La infraestructura de la aplicación 'WS_API_SAMPLE' de servicios Web de CA 3Tera AppLogic se presenta a continuación:

Tiene los componentes siguientes:

Suite de aplicación de muestra de API

Notas

Software de fuente abierta y de terceros utilizado

El siguiente software de terceros de fuente abierta está instalado en el volumen portal.

Software

Versión

Modificado

Licencia

Notas

JSON

2,15

No

Artistic

N/D

IPC-Run

0,82

No

GPLv2

N/D

XML-Simple

1,40

No

Artistic

N/D

Sort-Naturally

1,02

No

Artistic

N/D