Edge for Private Cloud v4.18.01
Verwenden Sie apigee-adminapi.sh um dieselben Edge-Konfigurationsaufgaben auszuführen, die Sie durch Aufrufen an den Edge- Management API Das Dienstprogramm apigee-adminapi.sh bietet folgende Vorteile:
- Einfache Befehlszeile verwenden
- Implementiert tabellarische Befehlsvervollständigung
- Bietet Hilfe und Informationen zur Nutzung
- Der entsprechende API-Aufruf kann angezeigt werden, wenn Sie die API testen möchten.
Das Dienstprogramm apigee-adminapi.sh ist kein Ersatz für das Dienstprogramm apigee-provision. Das Dienstprogramm apigee-provision verwendet tatsächlich die apigee-adminapi.sh um ihre Aufgaben auszuführen.
Die Hauptunterschiede zwischen den beiden sind folgende:
- Das Dienstprogramm apigee-adminapi.sh führt atomare Funktionen aus, die einzelne Edge API-Aufrufe ersetzen. Wenn Sie beispielsweise eine Organisation, eine Umgebung und einen virtuellen Host erstellen möchten, sind drei separate apigee-adminapi.sh-Befehle erforderlich, die drei API-Aufrufen entsprechen.
- Die apigee-provision ist darauf ausgelegt, einen vollständigen übergeordneten Vorgang in einem einzigen Befehl auszuführen. Für Sie können eine Organisation, Umgebung und einen virtuellen Host mit einem einzigen apigee-provision-Befehl durch und übergeben eine Konfigurationsdatei mit allen notwendigen Informationen.
Die Edge-Dokumentation verwendet gegebenenfalls beide Dienstprogramme.
apigee-adminapi.sh installieren
Das Dienstprogramm apigee-adminapi.sh ist automatisch installiert, wenn Sie das Dienstprogramm apigee-provision oder apigee-validate installieren.
Das Dienstprogramm wird im folgenden Verzeichnis installiert:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Syntax von apigee-adminapi.sh
Das Dienstprogramm apigee-adminapi.sh eine einfache Befehlszeilensyntax verwendet. Mit der Tabulatortaste können Sie jederzeit eine Aufforderung mit den verfügbaren Befehlsoptionen aufrufen.
Wenn Sie alle möglichen Befehle sehen möchten, führen Sie das Dienstprogramm ohne Optionen aus:
> 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:
> apigee-adminapi.sh orgs
Es werden die möglichen Optionen für den Befehl orgs angezeigt:
add apis apps delete envs list pods userroles
Mit der Option -h können Sie Hilfe bei jedem Befehl. Wenn Sie beispielsweise die Option -h verwenden, wie unten gezeigt:
> apigee-adminapi.sh orgs -h
Das Dienstprogramm zeigt vollständige Hilfeinformationen zu allen möglichen Optionen für den Befehl orgs an. Das erste Element in der Ausgabe zeigt die Hilfe zu orgs add an. Befehl:
+++++++++++++++++++++++++++++++++++++++++++
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 mithilfe von Befehlszeilenoptionen und Umgebungsvariablen festlegen
Sie müssen alle Parameter für einen Befehl entweder über Befehlszeilenoptionen oder über Umgebungsvariablen eingeben. 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
- Mit der Befehlszeilenoption -o:
> apigee-adminapi.sh orgs -o testOrg - So legen Sie eine Umgebungsvariable namens ORG fest:
> ORG=testOrg
exportieren > Apigee-adminapi.sh-Organisationen
Wenn Sie erforderliche Parameter für den Befehl weglassen, zeigt das Dienstprogramm eine Fehlermeldung an. und beschreiben die fehlenden Parameter. Wenn Sie beispielsweise die Umgebungsvariable --host oder EDGE_SERVER, die den Edge-Verwaltungsserver angibt, beim Erstellen einer Organisation weglassen, wird die folgende Fehlermeldung angezeigt:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Zwei gängige Parameter, die häufig als Umgebungsvariablen festgelegt werden, sind die E-Mail-Adresse des Systemadministrators und die IP-Adresse des Verwaltungsservers:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Datei an das Dienstprogramm apigee-adminapi.sh übergeben
Einige Befehle des Dienstprogramms apigee-adminapi.sh PUT- und POST API-Aufrufen entsprechen, die einen Anfragetext annehmen. Das Erstellen eines virtuellen Hosts entspricht beispielsweise einem POST-API-Aufruf, für den Informationen zum virtuellen Host im Anfragetext erforderlich sind.
Wenn Sie das Dienstprogramm apigee-adminapi.sh zum Erstellen eines virtuellen Hosts oder einen Befehl verwenden, der einen Anfragetext annimmt, können Sie alle erforderlichen Informationen wie unten gezeigt in der Befehlszeile übergeben:
> 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 der Anfragetext der POST-Anfrage. Im folgenden Befehl wird beispielsweise eine Datei verwendet, die den virtuellen Host definiert:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
wobei die Datei vhostcreate enthält den POST-Hauptteil des Aufrufs. In diesem Beispiel ist es 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 detaillierte Informationen zum Befehl anzuzeigen. Zu diesen Informationen gehört auch der cURL-Befehl, die vom Dienstprogramm apigee-adminapi.sh generiert werden, um den Vorgang auszuführen.
Im folgenden Befehl wird beispielsweise die Option --debug verwendet:
> 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