Diese Seite wurde von der Cloud Translation API übersetzt.

Dienstprogramm „apigee-adminapi.sh“ verwenden

Edge for Private Cloud v4.19.01

Der apigee-adminapi.sh ruft die Edge-Verwaltungs-API auf, um viele Wartungen durchzuführen Aufgaben.

Informationen zu apigee-adminapi.sh

Vorteile

Der Vorteil des Dienstprogramms apigee-adminapi.sh ist:

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

Vergleich mit Apigee-Bereitstellung

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:

apigee-adminapi.sh führt atomare Funktionen aus, die für einzelne Edge API-Aufrufe. Um z. B. eine Organisation, eine Umgebung und ein virtuelles drei separate apigee-adminapi.sh-Befehle für drei API-Aufrufe
apigee-provision führt eine vollständige allgemeine 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.

Installieren Sie apigee-adminapi.sh.

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

Rufen Sie apigee-adminapi.sh auf.

Sie rufen apigee-adminapi.sh über einen Verwaltungsserverknoten auf. Wenn Sie das Dienstprogramm aufrufen, müssen Sie definieren Sie Folgendes entweder als Umgebungsvariablen oder als Befehlszeilenoptionen:

ADMIN_EMAIL (entspricht der Befehlszeilenoption admin)
ADMIN_PASSWORD (pwd)
EDGE_SERVER (host)

Im folgenden Beispiel wird apigee-adminapi.sh aufgerufen und die erforderlichen Werte als Befehlszeile übergeben Optionen:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

Im folgenden Beispiel werden die erforderlichen Optionen als temporäre Umgebungsvariablen definiert. ruft das Dienstprogramm apigee-adminapi.sh auf:

export ADMIN_EMAIL=user@example.com
export ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list

Wenn Sie das Passwort nicht als Option übergeben oder es nicht als Umgebungsvariable definieren, apigee-adminapi.sh fordert Sie auf, ihn einzugeben.

Parameter von apigee-adminapi.sh festlegen

Sie müssen alle Parameter in einen Befehl eingeben. Verwenden Sie dazu entweder Befehlszeilenparameter oder Umgebungsvariablen. Stellen Sie den Befehlszeilenschaltern einen einfachen Bindestrich (-) oder einen doppelten Bindestrich voran (--) nach Bedarf.

Sie können den Namen der Organisation beispielsweise auf eine der folgenden Arten angeben:

Ü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

HINWEIS:Sie verwenden in der Regel Umgebungsvariablen, um ADMIN_EMAIL und EDGE_SERVER und optional ADMIN_PASSWORD Diese Parameter werden von den meisten Befehlen verwendet. Die Bedenken bei der Einstellung anderen Parametern wie ORG mithilfe von Umgebungsvariablen verwendet werden, besteht die Möglichkeit, für einen Befehl korrekt, aber für einen nachfolgenden Befehl falsch sein. Für Wenn Sie beispielsweise vergessen, die Umgebungsvariable zurückzusetzen, in den nächsten Befehl ein.

Wenn Sie erforderliche Parameter für den Befehl weglassen, zeigt das Dienstprogramm eine Fehlermeldung an. und beschreiben die fehlenden Parameter. Wenn Sie beispielsweise die Option --host (entspricht der Umgebungsvariable EDGE_SERVER), antwortet apigee-adminapi.sh mit folgendem Fehler:

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

Wenn der Fehler HTTP STATUS CODE: 401 angezeigt wird, haben Sie eine falsche Eingabe Passwort.

Hilfe zu apigee-adminapi.sh abrufen

Sie können jederzeit die Tabulatortaste drücken, um eine Eingabeaufforderung mit den verfügbaren Befehlsoptionen aufzurufen.

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

Übergeben Sie eine Datei an apigee-adminapi.sh

Das Dienstprogramm apigee-adminapi.sh ist ein Wrapper um curl. Daher haben einige Die Befehle entsprechen den API-Aufrufen PUT und POST, die einen Anfragetext annehmen. Das Erstellen eines virtuellen Hosts entspricht beispielsweise einem POST-API-Aufruf, für den Informationen zum 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 in diesem Beispiel 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 Befehl curl apigee-adminapi.sh generiert, um den Vorgang auszuführen.

Im folgenden Befehl wird beispielsweise die Option --debug verwendet. Die Ergebnisse Rufen Sie die Ausgabe des zugrunde liegenden curl-Befehls im ausführlichen Modus auf:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
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