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

Edge for Private Cloud v4.19.01

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

apigee-adminapi.sh について

apigee-adminapi.sh を呼び出す

Management Server ノードから apigee-adminapi.sh を呼び出します。このユーティリティを呼び出すときは、環境変数またはコマンドライン オプションとして次のものを定義する必要があります。

  • 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 のヘルプを見る

任意のコマンド オプションのリストを表示するには、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

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