Utilizzo dell'utilità Apigee-adminapi.sh

Edge per Private Cloud v4.18.05

Usa l'utilità apigee-adminapi.sh per eseguire le stesse attività di configurazione perimetrale che esegui effettuando chiamate all'API Edge Management. Il vantaggio per L'utilità di apigee-adminapi.sh è che:

  • Usa una semplice interfaccia a riga di comando
  • Implementa il completamento dei comandi basato su schede
  • Fornisce assistenza e informazioni sull'utilizzo
  • Puoi visualizzare la chiamata API corrispondente se decidi di provare l'API

L'utilità apigee-adminapi.sh non sostituisce il Utilità apigee-provision. L'utilità apigee-provision in realtà utilizza apigee-adminapi.sh per eseguire le proprie attività.

Le principali differenze tra i due sono:

  • L'utilità apigee-adminapi.sh esegue funzioni atomiche che sostituiscono alle singole chiamate API Edge. Ad esempio, per creare un'organizzazione, un ambiente richiede tre comandi apigee-adminapi.sh separati, corrispondenti a tre Chiamate API.
  • L'utilità apigee-provision è progettata per eseguire attività di alto livello con un solo comando. Ad esempio, puoi creare un'organizzazione, un ambiente con un singolo comando apigee-provision passando un file di configurazione tutte le informazioni necessarie.

La documentazione di Edge utilizza entrambe le utilità ove appropriato.

Installazione di apigee-adminapi.sh

L'utilità apigee-adminapi.sh viene installata automaticamente quando installi apigee-provision o l'utility apigee-validate.

L'utilità è installata nel seguente percorso:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Sintassi /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

L'utilità apigee-adminapi.sh utilizza una semplice sintassi della riga di comando. In qualsiasi momento, utilizza il tasto Tab per visualizzare un prompt che elenca le opzioni dei comandi disponibili.

Per visualizzare tutti i comandi possibili, richiama l'utilità senza opzioni:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Se premi il tasto Tab dopo aver digitato apigee-adminapi.sh, vedrai l'elenco di possibili opzioni:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

Il tasto Tab mostra le opzioni in base al contesto del comando. Se inserisci il tasto Tab Dopo aver digitato:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Verranno visualizzate le possibili opzioni per completare il comando orgs:

add  apis  apps  delete  envs  list  pods  userroles

Utilizza l'opzione -h per visualizzare la guida per qualsiasi comando. Ad esempio, se utilizzi Opzione -h come mostrato di seguito:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -h

L'utilità visualizza le informazioni della guida complete per tutte le opzioni possibili al Comando orgs. Il primo elemento nell'output mostra la guida per Comando orgs add:

+++++++++++++++++++++++++++++++++++++++++++
orgs add
  Required:
    -o ORG Organization name
  Optional:
    -H HEADER add http header in request
    --admin ADMIN_EMAIL admin email address
    --pwd ADMIN_PASSWORD admin password
    --host EDGE_SERVER edge server to make request to
    --port EDGE_PORT port to use for the http request
    --ssl set EDGE_PROTO to https, defaults to http
    --debug ( set in debug mode, turns on verbose in curl )
    -h      Displays Help

Impostazione dei parametri utilizzando le opzioni a riga di comando e le variabili di ambiente

Devi inserire tutti i parametri di un comando utilizzando le opzioni della riga di comando oppure variabili di ambiente. Fai precedere le opzioni della riga di comando da un trattino singolo (-) o due trattini. (--) come richiesto.

Ad esempio, dalla guida mostrata sopra per "orgs add" puoi specificare nome dell'organizzazione in uno dei seguenti modi:

  • Con l'opzione della riga di comando -o: 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • Impostazione di una variabile di ambiente denominata ORG: 
    > export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs
di Gemini Advanced.

Se ometti alcuni parametri obbligatori per il comando, l'utilità visualizza un messaggio di errore che descrive i parametri mancanti. Ad esempio, se ometti --host o Variabile di ambiente EDGE_SERVER che specifica l'Edge Management Server durante la creazione un'organizzazione, viene visualizzato il seguente messaggio di errore:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

Due parametri comuni che imposti spesso come variabili di ambiente sono l'indirizzo email dell'amministratore di sistema. e indirizzo IP del server di gestione: 

export ADMIN_EMAIL=foo@bar.com
export EDGE_SERVER=192.168.56.101

Passare un file a apigee-adminapi.sh società di servizi pubblici

Alcuni comandi di utilità apigee-adminapi.sh corrispondono alle chiamate API PUT e POST che accettano il corpo di una richiesta. Ad esempio, la creazione di un'istanza corrisponde a una chiamata API POST che richiede informazioni sull'host virtuale nella corpo della richiesta.

Quando utilizzi l'utilità apigee-adminapi.sh per creare un host virtuale o qualsiasi comando che prenda il corpo di una richiesta, puoi passare le informazioni necessarie nella riga di comando, come illustrato di seguito:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005

In alternativa, puoi trasmettere un file contenente le stesse informazioni contenute nella richiesta corpo del POST. Ad esempio, il comando seguente prende un file che definisce l'host virtuale:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

Dove il file vhostcreate contiene il corpo POST della chiamata. In questo esempio, è il corpo di una richiesta in formato XML:

<VirtualHost name="myVHostUtil">
   <HostAliases>
     <HostAlias>192.168.56.101:9005</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>9005</Port>
</VirtualHost>

Visualizzazione delle informazioni di debug e dell'API

Usa l'opzione --debug per l'utilità apigee-adminapi.sh per visualizzare informazioni dettagliate sul comando. Queste informazioni includono il comando curl generato l'utilità apigee-adminapi.sh per eseguire l'operazione.

Ad esempio, questo comando utilizza l'opzione --debug:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

Inoltre, visualizza l'output seguente, incluso il comando curl generato:

curl -H Content-Type: application/xml -v -X POST     -s -k -w \n==> %{http_code}
-u ***oo@bar.com:*****     http://localhost:8080/v1/o -d <Organization name="testOrg2" 
type="paid"/>
* About to connect() to localhost port 8080 (#0)
*   Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0