apigee-adminapi.sh
wywołuje interfejs Edge Management API, aby wykonać wiele zadań konserwacji.
Informacje o pliku apigee-adminapi.sh
Wywołaj plik apigee-adminapi.sh
Wywołujesz funkcję apigee-adminapi.sh
z węzła serwera zarządzania. Przy wywoływaniu narzędzia musisz zdefiniować następujące elementy jako zmienne środowiskowe lub opcje wiersza poleceń:
ADMIN_EMAIL
(odpowiada opcji wiersza poleceńadmin
)ADMIN_PASSWORD
(pwd
)EDGE_SERVER
(host
)
Ten przykład wywołuje funkcję apigee-adminapi.sh
i przekazuje wymagane wartości jako opcje wiersza poleceń:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost
Poniższy przykład określa wymagane opcje jako tymczasowe zmienne środowiskowe, a następnie wywołuje narzędzie apigee-adminapi.sh
:
export ADMIN_EMAIL=user@example.comexport ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list
Jeśli nie przekażesz hasła jako opcji lub nie zdefiniujesz go jako zmiennej środowiskowej, apigee-adminapi.sh
poprosi o jego podanie.
Ustaw parametry apigee-adminapi.sh
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 (--).
Możesz na przykład określić nazwę organizacji:
- Przy użyciu przełącznika wiersza poleceń
-o
:/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
- Ustawienie zmiennej środowiskowej o nazwie
ORG
:export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/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 pominiesz opcję --host
(odpowiadającą zmiennej środowiskowej EDGE_SERVER
), apigee-adminapi.sh
w odpowiedzi wyświetli ten błąd:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Jeśli wystąpi błąd HTTP STATUS CODE: 401
, oznacza to, że wpisane hasło jest nieprawidłowe.
Uzyskaj pomoc dotyczącą apigee-adminapi.sh
W każdej chwili możesz nacisnąć klawisz Tab, aby wyświetlić komunikat z listą dostępnych opcji polecenia.
Aby zobaczyć wszystkie dostępne polecenia, wywołaj narzędzie bez opcji:
/opt/apigee/apigee-adminapi/bin/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:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs
Zobaczysz dostępne opcje wykonania polecenia orgs
:
add apis apps delete envs list pods userroles
Aby wyświetlić pomoc dotyczącą dowolnego polecenia, użyj opcji -h
. Jeśli na przykład używasz opcji -h
, jak pokazano poniżej:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -h
Narzędzie wyświetla pełne informacje pomocy na temat wszystkich dostępnych opcji polecenia orgs
. Pierwszy element w danych wyjściowych pokazuje 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
Przekaż plik do apigee-adminapi.sh
Narzędzie apigee-adminapi.sh
otaczają tag curl
. W związku z tym niektóre polecenia odpowiadają wywołaniam interfejsu API PUT
i POST
, które przyjmują treść żądania.
Na przykład utworzenie hosta wirtualnego odpowiada wywołaniu interfejsu API POST
, które w treści żądania wymaga 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ń, tak jak w tym przykładzie:
/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
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:
/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
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świetl informacje na temat debugowania i interfejsu API
Użyj opcji --debug
w narzędziu apigee-adminapi.sh
, aby wyświetlić szczegółowe informacje o poleceniu. Te informacje obejmują polecenie curl
wygenerowane przez narzędzie apigee-adminapi.sh
w celu wykonania tej operacji.
Na przykład poniższe polecenie używa opcji --debug
. Wyniki wyświetlają dane wyjściowe podstawowego polecenia curl
w trybie szczegółowym:
/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