Korzystanie z narzędzia apigee-adminapi.sh

Edge for Private Cloud wer. 4.17.09

Za pomocą narzędzia apigee-adminapi.sh możesz wykonywać te same zadania konfiguracji Edge, które wykonujesz przez wywołania interfejsu Edge Management API. Korzyścią narzędzia apigee-adminapi.sh jest to, że:

  • Użyj prostego interfejsu wiersza poleceń
  • Implementuje wykonywanie poleceń za pomocą kart
  • Zawiera pomoc i informacje o użytkowaniu
  • Możesz wyświetlić odpowiednie wywołanie interfejsu API, jeśli zdecydujesz się go wypróbować.

Narzędzie apigee-adminapi.sh nie zastępuje narzędzia apigee-provision. Narzędzie apigee-provision faktycznie używa narzędzia apigee-adminapi.sh do wykonywania swoich zadań.

Oto główne różnice między nimi:

  • Narzędzie apigee-adminapi.sh wykonuje funkcje atomowe, które zastępują poszczególne wywołania Edge API. Aby na przykład utworzyć organizację, środowisko i host wirtualny, musisz wykonać 3 osobne polecenia apigee-adminapi.sh odpowiadające 3 wywołaniom interfejsu API.
  • Narzędzie apigee-provision zostało zaprojektowane do wykonywania pełnej operacji wysokiego poziomu w jednym poleceniu. Możesz na przykład utworzyć organizację, środowisko i hosta wirtualnego za pomocą jednego polecenia apigee-provision, przesyłając plik konfiguracji ze wszystkimi niezbędnymi informacjami.

Dokumentacja Edge korzysta w stosownych przypadkach z obu narzędzi.

Instalowanie pliku apigee-adminapi.sh

Narzędzie apigee-adminapi.sh jest instalowane automatycznie podczas instalacji narzędzia apigee-provision lub apigee-validate.

Narzędzie jest instalowane w następującej lokalizacji:

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

Składnia apigee-adminapi.sh

Narzędzie apigee-adminapi.sh używa prostej składni wiersza poleceń. W każdej chwili możesz użyć klawisza Tab, aby wyświetlić monit z listą dostępnych opcji poleceń.

Aby zobaczyć wszystkie dostępne polecenia, wywołaj narzędzie bez opcji:

> apigee-adminapi.sh 

Jeśli naciśniesz klawisz Tab po wpisaniu apigee-adminapi.sh, zobaczysz listę dostępnych opcji:

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

Klawisz Tab wyświetla opcje zależnie od kontekstu polecenia. Jeśli wpiszesz klawisz Tab po wpisaniu:

> apigee-adminapi.sh orgs

Zobaczysz dostępne opcje wykonywania polecenia orgs:

add  apis  apps  delete  envs  list  pods  userroles

Użyj opcji -h, aby wyświetlić pomoc dotyczącą dowolnego polecenia. Jeśli na przykład użyjesz opcji -h, jak pokazano poniżej:

> apigee-adminapi.sh orgs -h

Narzędzie wyświetli pełne informacje pomocy na temat wszystkich dostępnych opcji polecenia orgs. Pierwszy element w danych wyjściowych przedstawia pomoc dotyczącą polecenia "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

Ustawianie parametrów za pomocą przełączników wiersza poleceń i zmiennych środowiskowych

W poleceniu musisz wpisać wszystkie parametry, korzystając z przełączników wiersza poleceń lub zmiennych środowiskowych. W razie potrzeby poprzedź przełączniki wiersza poleceń pojedynczym łącznikiem (-) lub podwójnym łącznikiem (--).

Na przykład w powyższej pomocy dotyczącej polecenia „orgs add” możesz określić nazwę organizacji, wykonując jedną z tych czynności:

  • Za pomocą przełącznika wiersza poleceń -o:
    > apigee-adminapi.sh orgs -o testOrg
  • Ustawianie zmiennej środowiskowej o nazwie ORG:
    > Export ORG=testOrg
    > apigee-adminapi.sh orgs

Jeżeli pominiesz jakiekolwiek wymagane parametry w poleceniu, narzędzie wyświetli komunikat o błędzie z opisem brakujących parametrów. Jeśli na przykład podczas tworzenia organizacji pominiesz zmienną środowiskową --host lub EDGE_server określającą serwer zarządzania brzegowymi, zobaczysz ten komunikat o błędzie:

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

Dwa typowe parametry, które często ustawiasz jako zmienne środowiskowe, to adres e-mail administratora sys i adres IP serwera zarządzania:

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

Przekazywanie pliku do narzędzia apigee-adminapi.sh

Niektóre polecenia narzędzia apigee-adminapi.sh odpowiadają wywołaniam interfejsu PUT i POST API, które przyjmują treść żądania. Na przykład utworzenie hosta wirtualnego odpowiada wywołaniu interfejsu POST API, które wymaga podania w treści żądania informacji o hoście wirtualnym.

Gdy używasz narzędzia apigee-adminapi.sh do tworzenia hosta wirtualnego lub dowolnego polecenia, które pobiera treść żądania, możesz przekazać wszystkie niezbędne informacje w wierszu poleceń, jak pokazano poniżej:

> 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

Możesz też przekazać plik zawierający te same informacje, które byłyby zawarte w treści żądania POST. Na przykład to polecenie pobiera plik definiujący hosta wirtualnego:

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

gdzie plik vhostcreate zawiera treść POST wywołania. W tym przykładzie jest to treść żądania w formacie XML:

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

Wyświetlanie informacji o debugowaniu i interfejsie API

Użyj opcji --debug w narzędziu apigee-adminapi.sh, aby wyświetlić szczegółowe informacje o poleceniu. Informacje te obejmują polecenie cURL wygenerowane przez narzędzie apigee-adminapi.sh w celu wykonania tej operacji.

Na przykład to polecenie używa opcji --debug:

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

Wyświetla też te dane wyjściowe, w tym wygenerowane polecenie cURL:

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