Dienstprogramm „apigee-adminapi.sh“ verwenden

Edge for Private Cloud v4.18.05

Verwenden Sie das Dienstprogramm apigee-adminapi.sh, um die gleichen Edge-Konfigurationsaufgaben auszuführen die Sie ausführen, indem Sie die Edge-Verwaltungs-API aufrufen. Der Vorteil des apigee-adminapi.sh ist, dass es:

  • Einfache Befehlszeile verwenden
  • Implementiert tabellarische Befehlsvervollständigung
  • Bietet Hilfe und Informationen zur Nutzung
  • Kann den entsprechenden API-Aufruf anzeigen, wenn Sie die API ausprobieren möchten

Das Dienstprogramm apigee-adminapi.sh ist kein Ersatz für das Dienstprogramm apigee-provision. Das Dienstprogramm apigee-provision verwendet apigee-adminapi.sh, um Aufgaben auszuführen.

Die Hauptunterschiede zwischen den beiden sind folgende:

  • Das Dienstprogramm apigee-adminapi.sh führt atomare Funktionen aus, die einzelnen Edge API-Aufrufen. Um z. B. eine Organisation, eine Umgebung und ein virtuelles drei separate apigee-adminapi.sh-Befehle für drei API-Aufrufe
  • Das Dienstprogramm apigee-provision ist so konzipiert, dass es ein umfassendes mit einem einzigen Befehl ausführen. Sie können beispielsweise eine Organisation, eine Umgebung und virtuellen Host mit einem einzigen apigee-provision-Befehl durch Übergabe einer Konfigurationsdatei mit alle notwendigen Informationen.

Die Edge-Dokumentation verwendet gegebenenfalls beide Dienstprogramme.

apigee-adminapi.sh installieren

Das Dienstprogramm apigee-adminapi.sh wird automatisch installiert, wenn Sie die apigee-provision oder das Dienstprogramm apigee-validate.

Das Dienstprogramm wird unter folgendem Pfad installiert:

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

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

Das Dienstprogramm apigee-adminapi.sh verwendet eine einfache Befehlszeilensyntax. Sie können jederzeit die Tabulatortaste, um eine Eingabeaufforderung anzuzeigen, in der die verfügbaren Befehlsoptionen aufgelistet sind.

Um alle möglichen Befehle anzuzeigen, rufen Sie das Dienstprogramm ohne Optionen auf:

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

Wenn Sie nach der Eingabe von apigee-adminapi.sh die Tabulatortaste drücken, wird die Liste der möglichen Optionen:

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

Mit der Tabulatortaste werden Optionen basierend auf dem Kontext des Befehls angezeigt. Wenn Sie die Tabulatortaste nach der Eingabe:

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

Es werden die möglichen Optionen zum Ausführen des Befehls orgs angezeigt:

add  apis  apps  delete  envs  list  pods  userroles

Mit der Option -h können Sie für jeden Befehl die Hilfe aufrufen. Wenn Sie beispielsweise die Methode -h-Option wie unten gezeigt:

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

Das Dienstprogramm zeigt vollständige Hilfeinformationen für alle möglichen Optionen zum orgs-Befehl. Das erste Element in der Ausgabe zeigt die Hilfe für die Befehl 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

Parameter festlegen mit Befehlszeilen-Switches und Umgebungsvariablen verwenden,

Sie müssen alle Parameter in einen Befehl eingeben, indem Sie entweder Befehlszeilen-Switches oder Umgebungsvariablen. Stellen Sie den Befehlszeilenschaltern einen einfachen Bindestrich (-) oder einen doppelten Bindestrich voran (--) nach Bedarf.

In der Hilfe oben für „orgs add“ finden Sie können Sie den Parameter Name der Organisation entweder

  • Über den Befehlszeilenparameter -o: 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • So legen Sie eine Umgebungsvariable mit dem Namen ORG fest: 
    > export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Wenn Sie erforderliche Parameter für den Befehl weglassen, zeigt das Dienstprogramm eine Fehlermeldung an. und beschreiben die fehlenden Parameter. Wenn Sie beispielsweise --host oder Umgebungsvariable EDGE_SERVER, die den Edge-Verwaltungsserver beim Erstellen angibt einer Organisation, erhalten Sie die folgende Fehlermeldung:

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

Zwei häufige Parameter, die Sie häufig als Umgebungsvariablen festlegen, sind die E-Mail-Adresse des Systemadministrators. und IP-Adresse des Verwaltungsservers: 

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

Datei an apigee-adminapi.sh übergeben Dienstprogramm

Einige apigee-adminapi.sh-Dienstprogrammbefehle PUT- und POST API-Aufrufen entsprechen, die einen Anfragetext annehmen. So erstellen Sie z. B. ein virtuelles Host entspricht einem POST API-Aufruf, der Informationen über den virtuellen Host im Anfragetext.

Wenn Sie das Dienstprogramm apigee-adminapi.sh für Folgendes verwenden, oder einen Befehl erstellen, der einen Anfragetext annimmt, können Sie alle die erforderlichen Informationen in die Befehlszeile ein, wie unten gezeigt:

/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

Alternativ können Sie eine Datei übergeben, die dieselben Informationen enthält wie in der Anfrage enthalten wäre. Textkörper der POST-Anfrage. Der folgende Befehl verwendet beispielsweise eine Datei, die den virtuellen Host definiert:

/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

Die Datei vhostcreate enthält den POST-Text des Aufrufs. In diesem Beispiel ist ein XML-formatierter Anfragetext:

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

Debug- und API-Informationen anzeigen

Verwenden Sie die Option --debug für das Dienstprogramm apigee-adminapi.sh, um Folgendes aufzurufen: detaillierte Informationen zum Befehl. Zu diesen Informationen gehört auch der von das Dienstprogramm apigee-adminapi.sh, um den Vorgang auszuführen.

In diesem Befehl wird beispielsweise die Option --debug verwendet:

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

Die folgende Ausgabe wird angezeigt, einschließlich des generierten curl-Befehls:

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