Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Edge Microgateway の CLI リファレンス

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。情報

Edge Microgateway v. 2.3.x

概要

Edge Microgateway CLI を使用すると、Edge Microgateway インスタンスを全面的に制御、管理できます。

証明書の管理

cert コマンドを使用すると、クライアントが署名なしトークン（Edge Microgateway 経由で安全な呼び出しを行うために使用）に署名するために使用する公開鍵/秘密鍵のペアをインストールおよび管理できます。鍵は、Apigee Edge の安全な Vault に保存されます。Edge Microgateway は、公開鍵を使用して署名付きトークンを検証します。Edge Microgateway の設定と構成の説明に従って、edgemicro configure コマンドを実行すると、これらの鍵が生成されます。必要に応じて、ここで説明した cert コマンドを使用して、これらの鍵を再生成および管理できます。

証明書をインストールする

Apigee Edge のセキュアストアサービスを使用して、鍵を Vault にインストールし、公開鍵を出力として返します。鍵のペアのスコープは、指定された組織に設定されます。

使用方法

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-f, --force`	（省略可）鍵がすでに Vault に格納されている場合は、強制的にその鍵を交換します。
`-h, --help`	使用方法を出力します。

例

edgemicro cert install -o docs -e test -u jdoe@example.com -f

出力

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

証明書を削除する

組織の鍵のペアを削除します。

使用方法

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-h, --help`	使用方法を出力します。

例

edgemicro cert delete -o docs -e test -u jdoe@example.com

出力

deleting vault
Vault deleted!

証明書を確認する

組織に証明書がインストールされていることを確認します。

使用方法

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-h, --help`	使用方法を出力します。

例

edgemicro cert check -o docs -e test -u jdoe@example.com

出力 （成功）

checked cert successfully

出力 （失敗）

証明書が存在しない場合は、エラーが返されます。

公開鍵を取得する

指定した組織の公開鍵を返します。認証は必要ありません。

使用方法

edgemicro cert public-key -o [organization] -e [environment]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-h, --help`	使用方法を出力します。

例

edgemicro cert public-key -o docs -e test

出力 （サンプル）

Apigee Edge Cloud への Edge Microgateway の構成

Edge Microgateway を Apigee Edge Cloud インスタンスとともに使用できるようにします。必要な認証プロキシを Edge にデプロイし、認証トークンを生成して、構成ファイルを更新する一連のコマンドをラップして実行します。実際の例については、Edge Microgateway の設定と構成をご覧ください。

使用方法

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-r, --url`	（省略可）組織 / 環境の仮想ホストエイリアスを指定します。仮想ホストの詳細については、Edge のドキュメントをご覧ください。デフォルト: `org-env.apigee.net`
`-v, --virtualHosts`	（省略可）デフォルトの仮想ホスト「`default,secure`」をオーバーライドします。こうしたデフォルト以外の Edge 組織 / 環境に仮想ホストが指定されている場合は、このオプションを使用します。仮想ホストの詳細については、Edge のドキュメントをご覧ください。
`-d, --debug`	（省略可）デバッグ情報を提供します。
`-h, --help`	使用方法を出力します。

使用上の注意

このコマンドは、~/.edgemicro/org-env-config.yaml に構成情報を格納します。

例

edgemicro configure -o docs -e test -u jdoe@example.com

出力

成功すると、このコマンドは、Edge Microgateway の起動時に使用する必要がある一連の鍵を返します。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

キーの生成

genkeys コマンドは、Edge Microgateway が分析データを Apigee Edge に非同期に送信するときに、認証に使用するキーとシークレットのペアを生成します。

使用方法

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-h, --help`	使用方法を出力します。

使用上の注意

成功すると、このコマンドは 3 つの項目を返します。1 つは、構成ファイルに配置する必要のある URL です。他の 2 つは、Edge Microgateway インスタンスを起動するときに必要となる鍵のペアです。

ブートストラップ URL: この URL は、Edge Microgateway インスタンスが分析データを Apigee Edge に送信することを可能にする Apigee Edge サービスを指します。その URL を、Edge Microgateway 構成ファイル「~/.edgemicro/org-env-config.yaml」にコピーする必要があります。
key: 鍵。この鍵とシークレットは、Edge Microgateway のインスタンスを起動するために使用される CLI コマンドへの入力として必要です。
secret: シークレット。

例

edgemicro genkeys -o docs -e test -u jdoe@example.com

出力 （サンプル）

成功すると、このコマンドは、Edge Microgateway の起動時に使用する必要がある一連の鍵を返します。

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

Apigee Edge for Private Cloud への Edge Microgateway の構成

Edge Microgateway を Apigee Edge for Private Cloud インストールで動作するように構成します。

使用方法

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-u, --username`	Apigee ユーザー名。指定した組織の組織管理者である必要があります。
`-p, --password`	（省略可）パスワード。コマンドラインでこのパラメータを指定しない場合は、入力するよう要求されます。
`-r, --runtime-url`	プライベートクラウドインスタンスのランタイム URL を指定します。
`-m, --mgmt-url`	プライベートクラウドインスタンスの管理サーバーの URL。
`-v, --virtualHosts`	組織 / 環境の仮想ホストのカンマ区切りのリスト。デフォルトは「`default,secure`」です。
`-d, --debug`	（省略可）デバッグ情報を提供します。
`-h, --help`	使用方法を出力します。

使用上の注意

このコマンドは、~/.edgemicro/org-env-config.yaml に構成情報を格納します。

例

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

出力

成功すると、このコマンドは、Edge Microgateway の起動時に使用する必要がある一連の鍵を返します。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Edge Microgateway の起動

Edge Microgateway を起動する前に、まず edgemicro configure（Public Cloud）または edgemicro private configure（Private Cloud）を実行する必要があります。configure コマンドは、Edge Microgateway の起動に必要な鍵とシークレットの値を返します。

使用方法

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-k, --key`	「`edgemicro configure`」コマンドを実行すると返される Key-Value。
`-s, --secret`	「`edgemicro configure`」コマンドを実行すると返されるシークレットの値。
`-p, --processes`	（省略可）開始するプロセス数。デフォルト: システム上のコア数。
`-d, --pluginDir`	（省略可）プラグインディレクトリへの絶対パス。
`-r, --port`	（省略可）~`/.edgemicro/org-env-config.yaml` ファイルで指定されたポート番号をオーバーライドします。デフォルト: 8000
`-c, --cluster`	（省略可）Edge Microgateway をクラスタモードで起動します。注: v2.3.1 で、このオプションは削除されました。v2.3.1 以降のバージョンでは、Edge Microgateway は常にクラスタモードで起動します。
`-c --config`	（省略可）`default config.yaml` ファイルの場所を指定します。デフォルトでは、このファイルは `./config/config.yaml` にあります。
`-d, --debug`	（省略可）デバッグ情報を提供します。
`-h, --help`	使用方法を出力します。

ポートの設定

start コマンドを使用すると、構成ファイルで指定されたポートをオーバーライドするポート番号を指定できます。PORT 環境変数を使用してポート番号を指定することもできます。次に例を示します。

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

または

export PORT=8002 
edgemicro start -o org -e test -k key -s secret -p 2

ポートが使用中の場合、Edge Microgateway はエラーを返します。

クラスタリングについて

Edge Microgateway は、Node.js クラスタモジュールを使用してクラスタリングを有効にします。クラスタリングを使用することで、Edge Microgateway は、マルチコアシステムを利用できます。詳細については、こちらの Node.js ドキュメントをご覧ください。

例

edgemicro start -o docs -e test -k abc123 -s xyz456

出力例:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

トークンの管理

token コマンドを使用すると、署名付き OAuth2 アクセストークンを取得、デコード、検証できます。OAuth2 アクセストークンを使用した API 呼び出しの保護もご覧ください。

トークンをデコードする

エンコードされた署名付きトークンを書式なしテキストの JSON JWT（Java ウェブトークン）表現にデコードします。トークンは、アプリケーション名、client_id、製品リストなど、トークンの作成に使用された鍵を提供する Apigee Edge デベロッパーアプリに関する情報を伝えます。

使用方法

edgemicro token decode -f [filename]

パラメータ

パラメータ	説明
`-f, --file`	デコードする JWT トークンを含むファイルの名前。
`-h, --help`	使用方法を出力します。

例

edgemicro token decode -f token.jwt

出力（サンプル）

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

トークンを生成する

署名付きのトークンを生成します。このトークンにより、クライアントアプリは Edge Microgateway に対して認証 API 呼び出しを行うことができます。トークンは、OAuth 2.0 準拠の JSON ウェブトークン（JWT）です。Apigee Edge に登録されたデベロッパーアプリからコンシューマキー（クライアント ID）とコンシューマシークレット（クライアントシークレット）の値を入力する必要があります。OAuth2 アクセストークンを使用した API 呼び出しの保護もご覧ください。

使用方法

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-1, --key`	Microgateway 対応プロキシに関連付けられているデベロッパーアプリのクライアント ID。
`-s, --secret`	Microgateway 対応プロキシに関連付けられているデベロッパーアプリのクライアントシークレット。
`-h, --help`	使用方法を出力します。

例

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

出力（サンプル）

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

トークンを取得するための HTTP リクエストの作成

未処理の HTTP リクエストを作成して、トークンを取得することもできます。次に、curl の例を示します。URL の組織名と環境名を置き換えて、コンシューマ ID とコンシューマシークレットの各値を client_id と client_secret のパラメータと置き換えます。

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

トークンを検証する

指定された組織および環境の Apigee Edge に格納されている公開鍵に対する署名付きトークンを検証します。

使用方法

edgemicro token verify -o [org] -e [env] -f [filename]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-f, --file`	検証する JWT を含むファイル名。
`-h, --help`	使用方法を出力します。

例

edgemicro token get -o docs -e test -f token.jwt

有効なトークンの出力例

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

無効なトークンの出力例

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

期限切れトークンの出力例

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

署名なしトークンの直接取得

Apigee Edge のトークンエンドポイントに HTTP リクエストを送信して、署名なしトークンを直接取得することもできます。実際のトークンエンドポイントは、deploy-edge-service CLI コマンドでデプロイされたプロキシに実装されます。

次に、curl の例を示します。URL の組織名と環境名を置き換えて、Apigee Edge のデベロッパーアプリから取得したコンシューマ ID とコンシューマシークレットの各値を client_id と client_secret のパラメータと置き換えます。

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

出力例:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

新しい Edge Microgateway 構成の初期化

初めての Edge Microgateway のインストールが完了したら、このコマンドを 1 回実行してください。新しいデフォルト構成ファイル ~/.edgemicro/default.yaml を作成します。

使用方法

edgemicro init

パラメータ

パラメータ	説明
`-h, --help`	使用方法を出力します。

例

edgemicro init

出力 （成功）

config initialized to /MyHome/.edgemicro/default.yaml

Edge Microgateway 構成の確認

Edge Microgateway が正しく構成されていることを確認します。

使用方法

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-k, --key`	「`edgemicro configure`」コマンドを実行すると返される Key-Value。
`-s, --secret`	「`edgemicro configure`」コマンドを実行すると返されるシークレットの値。
`-h, --help`	使用方法を出力します。

例

edgemicro verify -o docs -e test -k abc123 -s xyz456

出力 （成功）

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

Edge Microgateway クラスタのステータスの確認

追加: v2.2.4-beta

デフォルトでは、Edge Microgateway はクラスタモードで起動します。このコマンドを使用すると、クラスタのステータスを確認できます。

使用方法

edgemicro status

パラメータ

パラメータ	説明
`-h, --help`	使用方法を出力します。

例

edgemicro status

出力 （成功）

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Edge Microgateway クラスタの停止

追加: v2.2.4-beta

Edge Microgateway クラスタを停止します。

使用方法

edgemicro stop

パラメータ

パラメータ	説明
`-h, --help`	使用方法を出力します。

例

edgemicro stop

出力 （成功）

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Edge Microgateway クラスタの再読み込み

追加: v2.2.4-beta

構成が変更されたら、ダウンタイムなしで再起動します。新しい構成を取り込み、Edge Microgateway を再読み込みします。

使用方法

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

パラメータ

パラメータ	説明
`-o, --org`	Edge Microgateway を構成した Apigee 組織。
`-e, --env`	Edge Microgateway を構成した環境。
`-k, --key`	「`edgemicro configure`」コマンドを実行すると返される Key-Value。
`-s, --secret`	「`edgemicro configure`」コマンドを実行すると返されるシークレットの値。
`-h, --help`	使用方法を出力します。

例

edgemicro reload -o docs -e test -k abc123 -s xyz456

出力 （成功）

...

Reload Completed Successfully