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 パラメータを設定する

コマンドライン スイッチを使用するか、 使用します。コマンドライン スイッチの先頭に 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 キーを使用して、使用可能なコマンド オプションを一覧表示するプロンプトをいつでも表示できます。

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

/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 オプションを使用して、 詳細情報が表示されます。この情報には、curl コマンドが含まれます。 （apigee-adminapi.sh ユーティリティによって生成されたもの）を使用して、オペレーションを実行します。

たとえば、次のコマンドでは --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