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

Edge for Private Cloud v4.18.05

apigee-adminapi.sh ユーティリティを使用して、同じ Edge 構成タスクを実行します。 Edge Management API を呼び出して実行します。Kubernetes の apigee-adminapi.sh ユーティリティの特徴は次のとおりです。

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

apigee-adminapi.sh ユーティリティは、 apigee-provision ユーティリティ。apigee-provision ユーティリティは実際には、 apigee-adminapi.sh ユーティリティを呼び出して、タスクを実行します。

両者の主な違いは次のとおりです。

  • apigee-adminapi.sh ユーティリティは、アトミック関数を実行して 個別の Edge API 呼び出しを行えます。たとえば、組織、環境、仮想エージェントを 対応する 3 つの apigee-adminapi.sh コマンドが必要です。 API 呼び出し。
  • apigee-provision ユーティリティは、完全な高レベル 使用できます。たとえば、組織、環境、組織、フォルダなど、 単一の apigee-provision コマンドで仮想ホストを作成する方法については、 必要な情報をすべて網羅しています。

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

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

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

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

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh の構文

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

パラメータの設定 コマンドライン スイッチと環境変数を使用する

コマンドライン スイッチを使用するか、 使用します。コマンドライン スイッチの先頭に 1 個のダッシュ（-）または 2 個のダッシュを付ける （--）を入力します。

たとえば、上記の「orgs add」のヘルプのコマンドを使用する場合、 次のいずれかの方法を使用できます。

  • -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 Management Server を指定する EDGE_SERVER 環境変数 組織を削除すると、次のエラー メッセージが表示されます。

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

環境変数としてよく設定される 2 つの一般的なパラメータは、システム管理者のメールアドレスです。 Management Server のアドレスと IP アドレスを入力します。

export ADMIN_EMAIL=foo@bar.com
export EDGE_SERVER=192.168.56.101

apigee-adminapi.sh にファイルを渡す ユーティリティ

一部の apigee-adminapi.sh ユーティリティ コマンド リクエスト本文を受け取る PUT API 呼び出しと 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 オプションを使用して、 詳細情報が表示されます。この情報には、Terraform で生成された curl コマンドと apigee-adminapi.sh ユーティリティでオペレーションを実行します。

たとえば、次のコマンドでは --debug オプションを使用しています。

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

生成された curl コマンドを含む次の出力が表示されます。

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