Edge for Private Cloud w wersji 4.16.05
Użyj pliku apigee-adminapi.sh. do wykonywania tych samych zadań konfiguracji Edge, które wykonujesz przy użyciu wywołań Edge do zarządzania interfejsami API. Zaletą narzędzia apigee-adminapi.sh jest to, że :
- Używanie prostego interfejsu wiersza poleceń
- Implementuje uzupełnianie poleceń na podstawie tabulacji
- Zapewnia pomoc i informacje na temat użytkowania
- Może wyświetlać odpowiednie wywołanie interfejsu API, jeśli zdecydujesz się wypróbować interfejs API
Narzędzie apigee-adminapi.sh nie jest dla narzędzia apigee-provision. Narzędzie apigee-provision faktycznie używa narzędzie apigee-adminapi.sh, do jego zadania.
Oto główne różnice między nimi:
- narzędzie apigee-adminapi.sh, wykonuje funkcje niepodzielne, które zastępują poszczególne wywołania interfejsu Edge API. Aby na przykład utworzyć organizacja, środowisko i host wirtualny wymagają 3 osobnych poleceń apigee-adminapi.sh. odpowiadające 3 wywołaniom interfejsu API.
- apigee-provision jest przeznaczona do wykonywania pełnej operacji wysokiego poziomu przy użyciu jednego polecenia. Dla: można na przykład utworzyć organizację, środowisko i hosta wirtualnego za pomocą apigee-provision przez przekazując plik konfiguracyjny ze wszystkimi niezbędnymi informacjami.
W miarę potrzeb dokumentacja Edge używa obu narzędzi.
Instaluję plik apigee-adminapi.sh
Narzędzie apigee-adminapi.sh to automatycznie zainstalowana podczas instalowania narzędzia apigee-provision lub apigee-validate.
To narzędzie jest zainstalowane w następującej lokalizacji:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Składnia apigee-adminapi.sh
narzędzie apigee-adminapi.sh, korzysta z 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 możliwe polecenia, wywołaj narzędzie bez żadnych opcji:
> apigee-adminapi.sh
Jeśli naciśniesz klawisz Tab po wpisaniu apigee-adminapi.sh, pojawi się lista możliwych opcje:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Klawisz Tab wyświetla opcje w zależności od kontekstu polecenia. Jeśli wpiszesz klawisz Tab po wpisaniu:
> apigee-adminapi.sh orgs
Zobaczysz dostępne opcje wykonania polecenia orgs:
add apis apps delete envs list pods userroles
Używaj opcji -h do wyświetlania do obsługi dowolnych poleceń. Jeśli na przykład użyjesz opcji -h w następujący sposób:
> apigee-adminapi.sh orgs -h
Narzędzie wyświetla pełną pomoc dotyczącą wszystkich dostępnych opcji polecenia orgs. Pierwszy element w danych wyjściowych pokazuje pomoc dotyczącą polecenia „dodawanie organizacji” polecenie:
+++++++++++++++++++++++++++++++++++++++++++ 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
Parametry ustawień za pomocą przełączników wiersza poleceń i zmiennych środowiskowych
Musisz wprowadzić wszystkie parametry polecenia, używając przełączników wiersza poleceń lub zmiennych środowiskowych. Do przełączników wiersza poleceń stosuj pojedynczy myślnik (-) lub podwójny myślnik w wierszu poleceń. (--) zgodnie z wymaganiami.
Na przykład w powyższym artykule pomocy na temat dodawania organizacji możesz określić nazwę organizacji przez:
- Użycie wiersza poleceń -o
przełącznik:
apigee-adminapi.sh orgs -o testOrg - Ustawianie zmiennej środowiskowej o nazwie ORG:
eksportuj ORG=testOrg
> Organizacje apigee-adminapi.sh
Jeśli pominiesz wymagane parametry w poleceniu, narzędzie wyświetli komunikat o błędzie. który zawiera opis brakujących parametrów. Jeśli np. pominiesz zmienną środowiskową --host lub EDGE_SERVER określającą serwer zarządzania brzegiem podczas tworzenia organizacji zostanie wyświetlony następujący 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 ustawia się jako zmienne środowiskowe, to adres e-mail administratora sys adres i adres IP serwera zarządzania:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Przekazywanie pliku do pliku apigee-adminapi.sh za usługi komunalne
Niektóre polecenia narzędzia apigee-adminapi.sh odpowiadają wywołaniom API PUT i POST, które przyjmują treść żądania. Na przykład utworzenie wirtualnej lokalizacji host odpowiada wywołaniu interfejsu POST API, które wymaga informacji o hoście wirtualnym w treść żądania.
Podczas korzystania z narzędzia apigee-adminapi.sh do hosta wirtualnego lub dowolnego polecenia, które ma treść żądania, możesz przekazać wszystkie w wierszu poleceń:
> 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 znajdują się w żądaniu żądania POST. Na przykład to polecenie powoduje utworzenie pliku definiującego 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ść wywołania POST. 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 na temat debugowania i interfejsu API
Użyj opcji --debug, aby: narzędzie apigee-adminapi.sh do wyświetlić szczegółowe informacje o poleceniu. Te informacje obejmują polecenie cURL wygenerowane przez narzędzie apigee-adminapi.sh w celu wykonaj operację.
Na przykład to polecenie korzysta z opcji --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
Zostanie wyświetlone następujące dane wyjściowe, wraz z wygenerowanym poleceniem 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