使用 apigee-adminapi.sh 公用程式

apigee-adminapi.sh 會呼叫 Edge Management API 來執行多項維護工作。

關於 apigee-adminapi.sh

叫用 apigee-adminapi.sh

您可以從管理伺服器節點叫用 apigee-adminapi.sh。叫用公用程式時，您必須將下列項目定義為環境變數或指令列選項：

  • ADMIN_EMAIL (對應至 admin 指令列選項)
  • ADMIN_PASSWORD (pwd)
  • EDGE_SERVER (host)

以下範例會叫用 apigee-adminapi.sh，並將必要值做為指令列選項傳遞：

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

以下範例將必要選項定義為臨時環境變數，然後叫用 apigee-adminapi.sh 公用程式：

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

如果您並未將密碼做為選項傳遞，或是未將密碼定義為環境變數，apigee-adminapi.sh 會提示您輸入密碼。

設定 apigee-adminapi.sh 參數

您必須使用指令列切換按鈕或使用環境變數，在指令中輸入所有參數。視需要在指令列切換鈕前方加上單破折號 (-) 或雙破折號 (--)。

舉例來說，您可以透過下列方式指定機構名稱：

  • 使用 -o 指令列切換按鈕： 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • 設定名為 ORG 的環境變數： 
    export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

如果您在指令中省略任何必要參數，公用程式會顯示錯誤訊息，說明缺少的參數。舉例來說，如果您省略與 EDGE_SERVER 環境變數相關的 --host 選項，apigee-adminapi.sh 就會回應下列錯誤：

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

如果收到 HTTP STATUS CODE: 401 錯誤，代表您輸入的密碼有誤。

取得 apigee-adminapi.sh 的說明

您隨時可以使用 Tab 鍵顯示提示，列出可用指令選項。

如要查看所有可能的指令，請在不使用選項的情況下叫用公用程式：

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

如果您在輸入 apigee-adminapi.sh 後按下 Tab 鍵，系統會顯示可能的選項清單：

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

Tab 鍵會根據指令內容顯示選項。如果您在輸入後進入 Tab 鍵：

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

畫面會顯示完成 orgs 指令的可能選項：

add  apis  apps  delete  envs  list  pods  userroles

使用 -h 選項即可顯示任何指令的說明。舉例來說，如果您使用 -h 選項，如下所示：

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

公用程式會顯示 orgs 指令所有可能選項的完整說明資訊。輸出內容的第一個項目顯示 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

將檔案傳送至 apigee-adminapi.sh

apigee-adminapi.sh 公用程式是 curl 的包裝函式。因此，部分指令會對應到會接受要求主體的 PUT 和 POST API 呼叫。舉例來說，建立虛擬主機對應的 POST API 呼叫需要在要求主體中取得虛擬主機的相關資訊。

使用 apigee-adminapi.sh 公用程式建立虛擬主機，或任何接受要求主體的指令時，您可以在指令列上傳遞所有必要資訊，如下所示：

/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

或者，您也可以傳送檔案包含與 POST 要求內文中相同的資訊。舉例來說，以下指令使用定義虛擬主機的檔案：

/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

其中 vhostcreate 檔案包含呼叫的 POST 主體。本例是 XML 格式的要求主體：

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

顯示偵錯和 API 資訊

使用 apigee-adminapi.sh 公用程式的 --debug 選項來顯示指令的詳細資訊。這項資訊包括 apigee-adminapi.sh 公用程式為了執行作業而產生的 curl 指令。

例如，下列指令使用 --debug 選項。結果會以詳細模式顯示基礎 curl 指令的輸出內容：

/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