Argomento precedente: WS_API - Applicazione API dei servizi WebArgomento successivo: Applicazioni di sistema


WS_API_SAMPLE - Applicazione di esempio di API dei servizi Web

Ultima versione: 1.0.7-1

L'applicazione WS_API_SAMPLE fornisce un esempio di come creare un'applicazione semplice di portale che acceda all'applicazione API del servizio WEB di CA AppLogic®, ovvero: WS_API. Questa applicazione viene fornita per aiutare gli sviluppatori di portali e applicazioni che inviano richieste API a un'istanza dell'applicazione WS_API in esecuzione in una griglia di CA AppLogic®.

Limite

Nome della proprietà

Tipo

Description

iface.in

Interfaccia

Rappresenta l'indirizzo IP con cui un utente può accedere al portale WS_API_SAMPLE. Questa proprietà è obbligatoria.

iface.net

Interfaccia

Rappresenta l'indirizzo IP utilizzato dall'applicazione WS_API_SAMPLE per inviare richieste basate su HTTP o HTTPS all'applicazione WS_API. Questa proprietà è obbligatoria.

iface.vpn

Interfaccia

Rappresenta l'indirizzo IP utilizzato dall'applicazione WS_API_SAMPLE per inviare richieste basate su HTTP all'applicazione WS_API su un tunnel VPN protetto. Questa proprietà è obbligatoria.

dns1

IP

Indirizzo IP di un server DNS per la definizione di nomi host. Questa proprietà è obbligatoria.

dns2

IP

Indirizzo IP di un server DNS di backup per le definizioni di nomi host. Predefinito: 0.0.0.0

api_ports

Stringa

Elenco delimitato da virgole di porte da cui è possibile accedere all'applicazione WS_API_SAMPLE. Predefinito: vuoto

allowed_hosts

Stringa

Indirizzo IP consentito o intervallo di indirizzo IP in formato di CIDR che possono accedere a WS_API_SAMPLE. Impostazione predefinita: 0.0.0.0/0 (consentire tutti)

Importante: gli indirizzi IP configurati nelle proprietà iface.vpn, iface.in e iface.net devono essere indirizzi IP disponibili sulla griglia di CA AppLogic®. Tali indirizzi sono contenuti nel dashboard della griglia assieme ai server DNS.

Risorse

Risorse

Min

Max

Predefinito

CPU

0.45

72

1.05

Memoria

704 MB

132 GB

1,343 GB

Larghezza di banda

6 Mbps

12 Gbps

1,151 Gbps

Volumi

L'applicazione BackupHelper ha il seguente volume:

Volume

Description

contenuto

File system che contiene script, log e interfaccia Web. Questo volume non dovrebbe essere modificato.

Introduzione

L'applicazione WS_API_SAMPLE deve essere configurata per accedere all'istanza di WS_API in esecuzione su una griglia di CA AppLogic®. Prima di avviare questa applicazione, avviare un'istanza dell'applicazione WS_API come indicato di seguito. WS_API_SAMPLE può essere configurato per le proprietà che vengono impostate nell'istanza dell'applicazione WS_API.

Per configurare WS_API_SAMPLE

  1. Modificare lo script del portale presente nella sottodirectory bin del volume del portale dell'applicazione e impostare la variabile IP nello script su:
  2. Impostare la variabile IP su iface.in per inviare richieste basate su HTTP o HTTPS all'applicazione WS_API o su aux per inviare richieste basate su HTTP su un tunnel VPN
  3. Modificare le informazioni di VDC in modo che corrispondano al vdcs.conf sull'applicazione WS_API. Ad esempio:
    # 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>
    Quanto precede dovrebbe apportare modifiche ai VDC configurati nell'applicazione WS_API. Se mygrid1 e mygrid2 sono due VDC in esecuzione rispettivamente a Dallas e San Diego, il codice HTML precedente dovrebbe essere modificato in: 
    # 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 può essere configurato per funzionare in una delle seguenti modalità:

Utilizzo di HTTP

In questa modalità, il portale utilizza una normale interfaccia basata su HTTP per inviare richieste API all'istanza di applicazione WS_API.
Ad esempio, curl "http://iface.in/api/v1/app/list?vdc=mygrid1".

Utilizzo di HTTPS

In questa modalità, il portale utilizza un'interfaccia protetta basata su HTTP per inviare richieste API all'istanza di applicazione WS_API. Perché questo avvenga, la chiave api_client.pem dovrebbe essere copiata nella sottodirectory delle chiavi nel volume del portale dell'applicazione WS_API_SAMPLE.
Ad esempio, curl -k -E /mnt/fs/keys/api_client.pem "https://iface.in/api/v1/app/list?vdc=mygrid1".

Utilizzo di tunnel VPN

In questa modalità, il portale utilizza una normale interfaccia basata su HTTP per inviare richieste API all'istanza di applicazione WS_API tramite un tunnel VPN protetto. Per creare il tunnel, copiare semplicemente client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt e ca.crt generati sulla sottodirectory del server del volume vpn_key dell'istanza dell'applicazione WS_API nella sottodirectory del client del volume vpn_key dell'applicazione WS_API_SAMPLE. Un tunnel protetto viene creato una volta che il componente out_vpn è stato avviato.
Ad esempio, curl "http://aux/api/v1/app/list?vdc=mygrid1".

Per accedere al portale tramite un browser Web, puntare il browser su http://iface.in/api/portal

Architettura di applicazione

L'infrastruttura dell'applicazione 'WS_API_SAMPLE' dei servizi Web di CA AppLogic® viene mostrata di seguito:

Contiene i seguenti componenti:

Applicazione esempio API

note

Software open source e di terze parti utilizzato

Il seguente software open source di terze parti è installato nel volume del portale.

Software

Versione

Modificato

License

note

JSON

2.15

No

Artistic

N/A

IPC-Run

0.80

No

GPLv2

N/A

XML-Simple

2.18

No

Artistic

N/A

Sort-Naturally

1.02

No

Artistic

N/A