使用 apigee-adminapi.sh 公用程式

Private Cloud v4.18.05 專用 Edge

使用 apigee-adminapi.sh 公用程式執行相同的 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-adminapi.sh當您安裝 apigee-provision 或 apigee-validate 公用程式。

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

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

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

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

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

您必須使用指令列開關，或是在指令中輸入所有參數， 環境變數在指令列切換鈕前面加上一個破折號 (-) 或雙破折號 (--)。

例如上述的「orgs add」(機構新增) 說明文章指令可指定 機構名稱依據：

  • 使用 -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
，瞭解如何調查及移除這項存取權。

如果您省略指令中的任何必要參數，公用程式會顯示錯誤訊息 說明遺漏的參數例如，如果您省略 --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 公用程式時 建立虛擬主機或任何可接收要求主體的指令 所有必要的資訊，如下所示：

/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 資訊

使用 --debug 選項搭配 apigee-adminapi.sh 公用程式來顯示 進一步瞭解指令當中包括 執行該作業的 apigee-adminapi.sh 公用程式。

舉例來說，這個指令使用 --debug 選項：

/opt/apigee/apigee-adminapi/bin/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