apigee-adminapi.sh ユーティリティの使用

apigee-adminapi.sh は、Edge Management API を呼び出してさまざまなメンテナンスタスクを実行します。

apigee-adminapi.sh について

利点

apigee-adminapi.sh ユーティリティには次のような利点があります。

シンプルなコマンドラインインターフェースを使用する。
タブベースのコマンド補完が実装されている。
ヘルプと使用方法の情報が提供される。
API を試したい場合、対応する API 呼び出しを表示できる。

apigee-provision との比較

apigee-adminapi.sh ユーティリティは、apigee-provision ユーティリティの代わりになるものではありません。apigee-provision ユーティリティは、実際には apigee-adminapi.sh ユーティリティを使用してタスクを実行します。

両者には主に次のような違いがあります。

apigee-adminapi.sh は、個々の Edge API 呼び出しに置き換えられるアトミック機能を実行します。たとえば、組織、環境、仮想ホストを作成するには、3 つの API 呼び出しに対応する 3 つの異なる apigee-adminapi.sh コマンドが必要です。
apigee-provision は、単一のコマンドで高レベルの包括的な操作を実行します。たとえば、必要なすべての情報を含む構成ファイルを渡すことにより、単一の apigee-provision コマンドで組織、環境、仮想ホストを一度に作成できます。

Edge のドキュメントでは、必要に応じて両方のユーティリティを使用しています。

apigee-adminapi.sh のインストール

apigee-adminapi.sh ユーティリティは、apigee-provision または apigee-validate ユーティリティをインストールするときに自動的にインストールされます。

このユーティリティは、次の場所にインストールします。

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

注: 通常は、環境変数を使用して ADMIN_EMAIL と EDGE_SERVER を設定し、必要に応じて ADMIN_PASSWORD を設定します。これらのパラメータはほとんどのコマンドで使用されます。環境変数を使用して ORG などの他のパラメータを設定した場合は、その設定があるコマンドでは正しいものの、後続のコマンドでは正しくない状況が起こり得ます。たとえば、環境変数をリセットするのを忘れた場合、正しくない値を誤って次のコマンドに渡す可能性があります。

コマンドに必要なパラメータを省略すると、不足しているパラメータを示すエラーメッセージが表示されます。たとえば、--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