使用 apigee-adminapi.sh 公用程式

Edge for Private Cloud 4.17.09 版

使用 apigee-adminapi.sh 公用程式,執行與呼叫 Edge Management API 相同的 Edge 設定工作。apigee-adminapi.sh 公用程式的優點如下:

  • 使用簡單的指令列介面
  • 實作 Tab 鍵指令完成功能
  • 提供說明和使用資訊
  • 如果您決定試用 API,可以顯示對應的 API 呼叫

apigee-adminapi.sh 公用程式無法取代 apigee-provision 公用程式。apigee-provision 公用程式實際上會使用 apigee-adminapi.sh 公用程式執行工作。

兩者主要差異如下:

  • apigee-adminapi.sh 公用程式會執行原子函式,取代個別 Edge API 呼叫。舉例來說,如要建立組織、環境和虛擬主機,需要三個不同的 apigee-adminapi.sh 指令,對應三個 API 呼叫。
  • apigee-provision 公用程式旨在透過單一指令執行完整的高階作業。舉例來說,您可以透過單一 apigee-provision 指令,傳遞包含所有必要資訊的設定檔,建立組織、環境和虛擬主機。

Edge 說明文件會視情況使用這兩種公用程式。

安裝 apigee-adminapi.sh

安裝 apigee-provision 或 apigee-validate 公用程式時,系統會自動安裝 apigee-adminapi.sh 公用程式。

公用程式會安裝在下列位置:

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

apigee-adminapi.sh 語法

apigee-adminapi.sh 公用程式採用簡單的指令列語法。您隨時可以使用 Tab 鍵顯示提示,列出可用的指令選項。

如要查看所有可能的指令,請叫用不含選項的公用程式:

> apigee-adminapi.sh 

輸入 apigee-adminapi.sh 後按下 Tab 鍵,就會看到可能的選項清單:

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

Tab 鍵會根據指令的內容顯示選項。輸入以下內容後按下 Tab 鍵:

> apigee-adminapi.sh orgs

您會看到完成 orgs 指令的可能選項:

add  apis  apps  delete  envs  list  pods  userroles

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

> 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

使用指令列切換和環境變數設定參數

您必須使用指令列切換參數或環境變數,為指令輸入所有參數。視需要為指令列切換加上單破折號 (-) 或雙破折號 (--) 前置字元。

舉例來說,根據上方顯示的「orgs add」指令說明,您可以透過下列任一方式指定組織名稱:

  • 使用 -o 指令列切換:
    > apigee-adminapi.sh orgs -o testOrg
  • 設定名為 ORG 的環境變數:
    > export ORG=testOrg
    > apigee-adminapi.sh orgs

如果省略指令的任何必要參數,公用程式會顯示錯誤訊息,說明缺少的參數。舉例來說,如果您在建立組織時省略指定 Edge Management Server 的 --host 或 EDGE_SERVER 環境變數,就會看到下列錯誤訊息:

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

您通常會設為環境變數的兩個常見參數,是系統管理員電子郵件地址和管理伺服器的 IP 位址:

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

將檔案傳遞至 apigee-adminapi.sh 公用程式

部分 apigee-adminapi.sh 公用程式指令對應至採用要求主體的 PUT 和 POST API 呼叫。舉例來說,建立虛擬主機相當於 POST API 呼叫,要求主體中必須包含虛擬主機的相關資訊。

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

> 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 要求主體相同的資訊。舉例來說,下列指令會採用定義虛擬主機的檔案:

> 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 選項:

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

並顯示下列輸出內容,包括產生的 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