本頁面由 Cloud Translation API 翻譯而成。

使用 apigee-adminapi.sh 公用程式

Edge for Private Cloud 4.18.01

使用 apigee-adminapi.sh 公用程式，藉由呼叫 Edge 來執行相同的 Edge 設定工作 Management APIapigee-adminapi.sh 公用程式的優點如下：

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

apigee-adminapi.sh 公用程式並非 apigee-provision 公用程式的替代方案。apigee-provision 公用程式實際使用使用 apigee-adminapi.sh 公用程式以執行其工作

兩者的主要差異如下：

apigee-adminapi.sh 公用程式會執行原子函式，取代個別 Edge API 呼叫。舉例來說，如要建立機構、環境和虛擬主機，就需要三個對應於三個 API 呼叫的 apigee-adminapi.sh 指令。
apigee-provision 公用程式可在單一指令中執行完整的高層級作業。適用對象舉例來說，您可以用單一 Pod 建立機構、環境和虛擬主機使用 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 的環境變數：
>匯出 ORG=testOrg
>apigee-adminapi.sh 機構

，瞭解如何調查及移除這項存取權。

如果您省略指令的任何必要參數，公用程式就會顯示錯誤訊息，說明缺少的參數。舉例來說，如果您省略 --host 或 EDGE_SERVER 環境變數，請指定 Edge Management 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 資訊

使用 --debug 選項，讓 apigee-adminapi.sh 公用程式顯示指令的詳細資訊。這項資訊包含 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