Edge for Private Cloud v4.19.01
apigee-adminapi.sh は、Edge 管理 API を呼び出してさまざまなメンテナンス タスクを行います。
apigee-adminapi.sh について
apigee-adminapi.sh の呼び出し
apigee-adminapi.sh は Management Server ノードから呼び出します。このユーティリティを呼び出すとき、次の値を環境変数として定義するか、コマンドライン オプションとして渡す必要があります。
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
コマンドに必要なパラメータを省略すると、欠落しているパラメータを示すエラー メッセージが表示されます。たとえば、--host オプション（これは EDGE_SERVER 環境変数に対応します）を省略すると、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 のヘルプを見る
いつでもタブキーを押すことで、使用可能なコマンド オプションが一覧表示されます。
すべての有効なコマンドを表示するには、オプションなしでユーティリティを起動します。
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
「apigee-adminapi.sh」と入力した後にタブキーを押すと、有効なオプションのリストが表示されます。
analytics classification logsessions regions securityprofile userroles
buildinfo GET orgs runtime servers users
タブキーは、コマンドのコンテキストに基づいてオプションを表示します。次のように入力してからタブキーを入力するとします。
/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