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

apigee-adminapi.sh は、Edge Management 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 パラメータを設定する

コマンドライン スイッチを使用するか、環境変数を使用して、コマンドにすべてのパラメータを入力する必要があります。必要に応じて、コマンドライン スイッチの先頭に 1 つのダッシュ（-）または 2 つのダッシュ（--）を付けます。

たとえば、組織名は次のいずれかで指定します。

  • -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 キーを使用すると、使用可能なコマンド オプションをリストするプロンプトをいつでも表示できます。

使用可能なすべてのコマンドを表示するには、オプションを指定せずに Jetifier ユーティリティを呼び出します。

/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