このページは Cloud Translation API によって翻訳されました。

リファレンス

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。詳細

apigee-remote-service-cli コマンドラインインターフェース（CLI）は、Apigee Adapter for Envoy のプロビジョニングと管理に役立ちます。

バインディング一覧表示コマンド

リモートサービスにバインドされているすべての API プロダクトを一覧表示します。

使用法

apigee-remote-service-cli bindings list [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-e, ‑‑environment`	必須	すべて	（文字列）組織内の環境。
`-h, ‑‑help`	省略可	すべて	コマンドパラメータのヘルプを表示します。
`‑‑insecure`	省略可	すべて	SSL 使用時に安全でないサーバー接続を許可する。
`‑‑legacy`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud を使用している場合は、このフラグを設定する必要があります。Apigee Edge for Public Cloud の管理 URL とランタイム URL を設定します。
`-m, ‑‑management`	必須	Edge Private Cloud のみ	（文字列）Apigee Edge for Private Cloud インストールの管理 URL です。デフォルト: `https://api.enterprise.apigee.com`
`‑‑mfa`	必須	Edge Public Cloud のみ	（文字列）Apigee Edge for Public Cloud の多要素認証トークン。MFA の場合のみ必須 Apigee Edge アカウントで設定されます。
`‑‑opdk`	必須	Edge Private Cloud のみ	Apigee Edge for Private Cloud を使用している場合は、このフラグを設定する必要があります。
`-o, ‑‑organization`	必須	すべて	（文字列）Apigee 組織。組織管理者である必要があります。
`-p, ‑‑password`	必須（Basic Auth のみ）	Edge Public Cloud と Private Cloud のみ	（文字列）Apigee のパスワード。必要に応じて、`.netrc` ファイルでパスワードを指定できます。認証情報に .netrc を使用するもご覧ください。
`-r, ‑‑runtime`	必須	Edge Private Cloud と Apigee ハイブリッドのみ	（文字列）Private Cloud または Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	任意	Edge Private Cloud のみ	（文字列）クライアント側の TLS 証明書、秘密鍵、mTLS 接続のルート CA を指定します。
`-t, ‑‑token`	必須（OAuth トークン認証のみ）	すべて	（文字列）Apigee アカウント情報から生成される OAuth トークンまたは SAML トークン。指定された他の認証情報をオーバーライドします。
`-u, ‑‑username`	必須（Basic Auth のみ）	Edge Public Cloud と Private Cloud のみ	（文字列）Apigee のユーザー名（通常はメールアドレス）。必要に応じて、ユーザー名を `.netrc` ファイルでも指定できます。その場合、コマンドラインでユーザー名を指定する必要はありません。認証情報に .netrc を使用するもご覧ください。
`-v, ‑‑verbose`	任意	すべて	（省略可）冗長な出力を生成します。

例

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \
-c config.yaml -p abc123

出力例

PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

ヘルプコマンド

すべての apigee-remote-service-cli コマンドにオンラインヘルプが用意されています。次のコマンドを入力してください。

apigee-remote-service-cli help

特定のコマンドのヘルプを表示するには、次のコマンドを入力します。

apigee-remote-service-cli [command] help

次に例を示します。

apigee-remote-service-cli provision help

プロビジョニングコマンド

apigee-remote-service-cli provision コマンドは、Apigee Edge 組織に 2 つの API プロキシをインストールし、証明書を設定して、Apigee Adapter for Envoy の構成に必要な認証情報を生成します。

使用法

apigee-remote-service-cli provision [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`‑‑analytics-sa`	省略可	Apigee ハイブリッドと Apigee X のみ	（文字列）`Apigee Analytics Agent` のロールを持つサービスアカウントの Google Cloud サービスアカウントキーファイルのパスを指定するには、このフラグを使用します。SA は、アナリティクスデータを Apigee に直接アップロードするため、アダプタによって使用されます。Apigee ハイブリッドを使用している場合は、このオプションを使用すると、一方のクラスタにハイブリッドランタイムを、もう一方のクラスタにアダプタをインストールできます。注: インストールを更新して、アナリティクスの直接アップロードを使用することをおすすめします。Fluentd を使用した直接ではないアナリティクスのアップロード方法は廃止されました。
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-e, ‑‑environment`	必須	すべて	（文字列）組織内の環境。
`-f, ‑‑force-proxy-install`	省略可	すべて	（省略可）組織に `remote-service` プロキシがすでにインストールされている場合は、強制的に再インストールします。アップグレードの注: v1.1.0 以降のバージョンにアップグレードする場合は、`--force-proxy-install` フラグを含めて、Apigee でデプロイされている既存のリモートプロキシサービス置き換えます。
`-h, ‑‑help`	省略可	すべて	コマンドパラメータのヘルプを表示します。
`‑‑insecure`	省略可	すべて	SSL 使用時に安全でないサーバー接続を許可する。
`‑‑legacy`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud を使用している場合は、このフラグを設定する必要があります。Apigee Edge for Public Cloud の管理 URL とランタイム URL を設定します。
`-m, ‑‑management`	必須	Edge Private Cloud のみ	（文字列）Apigee Edge for Private Cloud インストールの管理 URL です。デフォルト: `https://api.enterprise.apigee.com`
`‑‑mfa`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud の多要素認証トークン。MFA の場合のみ必須 Apigee Edge アカウントで設定されます。
`-n, ‑‑namespace`	省略可	すべて	（文字列）指定された名前空間で構成を Envoy ConfigMap として発行します。デフォルト: `apigee`
`‑‑opdk`	必須	Edge Private Cloud のみ	Apigee Edge for Private Cloud を使用している場合は、このフラグを設定する必要があります。
`-o, ‑‑organization`	必須	すべて	（文字列）Apigee 組織。プロビジョニングするには組織管理者でなければなりません。
`-p, ‑‑password`	必須（Basic Auth のみ）	Edge Public Cloud と Private Cloud のみ	（文字列）Apigee のパスワード。必要に応じて `.netrc` ファイルのパスワード。その場合、コマンドラインでパスワードを指定する必要はありません。関連項目認証情報に .netrc を使用する
`‑‑rotate-int`	省略可	Apigee ハイブリッドのみ	（整数）n > 0 の場合、新しい秘密鍵を生成し、n 公開鍵を保持します（混合型のみ）。
`-r, ‑‑runtime`	必須	Edge Private Cloud と Apigee ハイブリッドのみ	（文字列）Private Cloud または Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	任意	Edge Private Cloud のみ	（文字列）クライアント側の TLS 証明書、秘密鍵、mTLS 接続のルート CA を指定します。
`-t, ‑‑token`	必須（OAuth トークン認証のみ）	すべて	（文字列）Apigee アカウント情報から生成される OAuth トークンまたは SAML トークン。指定された他の認証情報をオーバーライドします。
`-u, ‑‑username`	必須（Basic Auth のみ）	Edge Public Cloud と Private Cloud のみ	（文字列）Apigee のユーザー名（通常はメールアドレス）。必要に応じて、ユーザー名を `.netrc` ファイルでも指定できます。認証情報に .netrc を使用するもご覧ください。
`-v, ‑‑verbose`	任意	すべて	（省略可）冗長な出力を生成します。
`‑‑virtual-hosts`	省略可	Edge Private Cloud のみ	（文字列）デフォルトの仮想ホスト `default,secure` をオーバーライドします。このオプションは、 Edge 組織環境に、これらのデフォルト以外の仮想ホストが指定されている。

例

次の例に示すように、provision コマンドの出力をファイルにキャプチャすることが重要です。このコマンドは他の Apigee Adapter for Envoy オペレーションの入力として使用されます。

例:

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
--organization $ORG --environment $ENV > config.yaml

サンプルコマンド

サンプル構成ファイルを作成し、一覧表示します。

サンプル構成ファイルを作成する

ネイティブの Envoy と Istio のデプロイのサンプル構成ファイルを作成します。

使用法

apigee-remote-service-cli samples create [flags]

説明

このコマンドでは、有効な config.yaml ファイルが入力として必要です。この入力ファイルは、プロビジョニングによって生成されたファイルです。デフォルトでは、サンプルファイルは ./samples という名前のディレクトリに出力されます。このコマンドにより、このディレクトリが作成されます。

ネイティブの Envoy を使用している場合、このコマンドで、ターゲットサービスホストとそのクラスタの名前を指定します。また、tls.key と tls.crt が含まれているフォルダが --tls によって指定されている場合、Envoy プロキシからリモートサービスクラスタへのカスタム SSL 接続も設定します。

Envoy プロキシがサイドカーとして機能する Istio を使用する場合は、ターゲットが指定されないと、httpbin の例が生成されます。それ以外の場合は、ターゲットサービスのデプロイに関連する構成ファイルを準備する必要があります。

パラメータ

パラメータ	要否	サービスで使用	説明
`‑‑adapter‑host`	Envoy テンプレートでのみ必須	すべて	（文字列）アダプタのホスト名（デフォルト: `localhost`）。
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-f, ‑‑force`	省略可	すべて	既存のディレクトリを強制的に上書きします。
`-h, ‑‑help`	省略可	すべて	コマンドパラメータのヘルプを表示します。
`‑‑host`	Envoy テンプレートでのみ必須	すべて	（文字列）ターゲットサービスホスト（デフォルト `httpbin.org`）。
`-n, ‑‑name`	Required	すべて	（文字列）ターゲットサービス名（デフォルト `httpbin.org`）。
`‑‑out`	省略可	すべて	（文字列）サンプル構成ファイルを作成するディレクトリ。デフォルトでは `./samples`。
`‑‑tag`	Istio テンプレートでのみ必須	すべて	（文字列）Envoy Adapter イメージのバージョンタグ。デフォルト: `v2.0.0`
`-t, ‑‑template`	Required	すべて	（文字列）Envoy または Istio のテンプレート名。利用可能なテンプレートのリストを表示するには、次のコマンドを実行します。 `apigee-remote-service samples templates`。
`‑‑tls`	Envoy テンプレートの場合のみ省略可。	すべて	（文字列）アダプタサービスに使用される `tls.key` ファイルと `tls.crt` ファイルを含むディレクトリ。

例

apigee-remote-service-cli samples create -c ./config.yaml

利用可能なテンプレートオプションを一覧表示する

samples コマンドの --templates パラメータで使用できるテンプレートを一覧表示します。

使用法

apigee-remote-service-cli samples templates

パラメータ

なし

例

apigee-remote-service-cli samples templates

Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

トークンコマンド

API キーではなく、JWT トークンを使用して、認証済みの API プロキシ呼び出しを行えます。トークンコマンドを使用すると、この目的のために JWT トークンの作成、検査、ローテーションを行えます。

JWT トークンを作成する

JWT トークンを使用して、リモートサービスターゲットに対して認証済みの API プロキシ呼び出しを行うことができます。JWT ベースの認証の使用もご覧ください。

使用法

apigee-remote-service-cli token create [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-e, ‑‑environment`	必須	すべて	（文字列）組織内の環境。
`-h, ‑‑help`	省略可	すべて	コマンドパラメータのヘルプを表示します。
`--i, --id`	必須	すべて	（文字列）Apigee デベロッパーアプリの Key 認証情報。API キーを取得する方法をご覧ください。
`‑‑insecure`	省略可	すべて	SSL 使用時に安全でないサーバー接続を許可する。
`‑‑legacy`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud を使用している場合は、このフラグを設定する必要があります。Apigee Edge for Public Cloud の管理 URL とランタイム URL を設定します。
`‑‑opdk`	必須	Edge Private Cloud のみ	Apigee Edge for Private Cloud を使用している場合は、このフラグを設定する必要があります。
`-o, ‑‑organization`	必須	すべて	（文字列）Apigee 組織。組織管理者である必要があります。
`-r, ‑‑runtime`	必須	Edge Private Cloud と Apigee ハイブリッドのみ	（文字列）Private Cloud または Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`--s, ‑‑secret`	必須	すべて	（文字列）Apigee デベロッパーアプリの Secret 認証情報。API キーを取得する方法をご覧ください。
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	任意	Edge Private Cloud のみ	（文字列）クライアント側の TLS 証明書、秘密鍵、mTLS 接続のルート CA を指定します。
`-v, ‑‑verbose`	任意	すべて	（省略可）冗長な出力を生成します。

例

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 \
-s icTARgaKHqvUH1dq -c config.yaml

出力

成功すると、次のような JST トークンの出力が表示されます。

eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

JWT トークンを検査する

このコマンドで JWT トークンを検査できます。トークンを検査するもご覧ください。

使用法

apigee-remote-service-cli token inspect [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-e, ‑‑environment`	必須	すべて	（文字列）組織内の環境。
`-f, ‑‑file`	必須	すべて	（文字列）トークンファイル（デフォルト: `stdin` を使用）。
`-h, ‑‑help`	省略可	すべて	コマンドパラメータのヘルプを表示します。
`‑‑insecure`	省略可	すべて	SSL 使用時に安全でないサーバー接続を許可する。
`‑‑legacy`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud を使用している場合は、このフラグを設定する必要があります。Apigee Edge for Public Cloud の管理 URL とランタイム URL を設定します。
`‑‑opdk`	必須	Edge Private Cloud のみ	Apigee Edge for Private Cloud を使用している場合は、このフラグを設定する必要があります。
`-o, ‑‑organization`	必須	すべて	（文字列）Apigee 組織。組織管理者である必要があります。
`-r, ‑‑runtime`	必須	Edge Private Cloud と Apigee ハイブリッドのみ	（文字列）Private Cloud または Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	任意	Edge Private Cloud のみ	（文字列）クライアント側の TLS 証明書、秘密鍵、mTLS 接続のルート CA を指定します。
`-v, ‑‑verbose`	任意	すべて	（省略可）冗長な出力を生成します。

例

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

出力

成功すると、次のような出力が表示されます。

{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

JWT トークンをローテーションする

JWT を最初に生成した後、Apigee によって暗号化された Key-Value マップ（KVM）に保存された公開鍵と秘密鍵のペアの変更が必要になることがあります。新しい鍵ペアを生成するこのプロセスは、鍵のローテーションと呼ばれます。鍵をローテーションすると、新しい秘密鍵と公開鍵のペアが生成され、Apigee Edge 組織 / 環境の istio KVM に保存されます。また、元の公開鍵は元の鍵 ID 値と一緒に保持されます。

使用法

apigee-remote-service-cli token rotate-cert [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`-c, ‑‑config`	必須	すべて	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-e, ‑‑environment`	必須	すべて	（文字列）組織内の環境。
`-h, ‑‑help`	任意	Edge Public Cloud と Private Cloud のみ	コマンドパラメータのヘルプを表示します。
`--k, --key`	必須	Edge Public Cloud と Private Cloud のみ	（文字列）プロビジョニングキー。
`‑‑insecure`	任意	Edge Public Cloud と Private Cloud のみ	SSL 使用時に安全でないサーバー接続を許可する。
`‑‑legacy`	必須	Edge Public Cloud のみ	Apigee Edge for Public Cloud を使用している場合は、このフラグを設定する必要があります。Apigee Edge for Public Cloud の管理 URL とランタイム URL を設定します。
`‑‑opdk`	必須	Edge Private Cloud のみ	Apigee Edge for Private Cloud を使用している場合は、このフラグを設定する必要があります。
`-o, ‑‑organization`	必須	Edge Public Cloud と Private Cloud のみ	（文字列）Apigee 組織。組織管理者である必要があります。
`-r, ‑‑runtime`	必須	Edge Private Cloud のみ	（文字列）Private Cloud または Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`--s, ‑‑secret`	必須	すべて	（文字列）プロビジョニングのシークレット。
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	任意	Edge Private Cloud のみ	（文字列）クライアントサイドの TLS 証明書、秘密鍵、mTLS 接続のルート CA を指定します。
`--t, ‑‑truncate`	必須	すべて	（整数）JWKS に保持する証明書の数（デフォルトでは 2）。
`-v, ‑‑verbose`	省略可	すべて	（省略可）冗長な出力を生成します。

例

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \
-k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \
-s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

出力

certificate successfully rotated

内部トークンを作成する

リモートサービス API 呼び出しを承認するための JWT トークンを作成します。

使用法

apigee-remote-service-cli token internal [flags]

パラメータ

パラメータ	要否	サービスで使用	説明
`-c, ‑‑config`	必須	Apigee ハイブリッドのみ	（文字列）Apigee リモートサービス構成ファイルのパス。ヒント: このフラグを使用すると、他のコマンドパラメータを省略できます。これは、CLI で構成ファイルから直接 pull できるためです。`‑‑config` オプションの使用をご覧ください。
`-d, ‑‑duration`	必須	Apigee ハイブリッドのみ	（文字列）内部 JWT の作成から有効な時刻（デフォルトでは `10m0s`（10 分））。
`-e, ‑‑environment`	必須	Apigee ハイブリッドのみ	（文字列）組織内の環境。
`-h, ‑‑help`	省略可	Apigee ハイブリッドのみ	コマンドパラメータのヘルプを表示します。
`‑‑insecure`	省略可	Apigee ハイブリッドのみ	SSL 使用時に安全でないサーバー接続を許可する。
`-o, ‑‑organization`	必須	Apigee ハイブリッドのみ	（文字列）Apigee 組織。組織管理者である必要があります。
`-r, ‑‑runtime`	必須	Apigee ハイブリッドのみ	（文字列）Apigee Hybrid インスタンスのランタイム URL を指定します。先頭は `https://` でなければなりません。例: `https://apitest.apigee-hybrid-docs.net`
`-v, ‑‑verbose`	省略可	Apigee ハイブリッドのみ	（省略可）冗長な出力を生成します。

バージョンコマンド

CLI バージョンを出力する

apigee-remote-service-cli version

認証情報に .netrc を使用する

Edge Public Cloud を使用していて api.enterprise.apigee.com マシンへのエントリがある場合、apigee-remote-service-cli は、ホームディレクトリの .netrc ファイルから username と password を自動的に取得します（基本認証に必要な場合）。Apigee Private Cloud を使用している場合、マシン値は management URL と同じになります（例: http://192.162.55.100）。 Edge Public Cloud の場合の例:

machine api.enterprise.apigee.com
login jdoe@google.com
password abc123

Edge Private Cloud での例:

machine http://192.162.55.100
login jdoe@google.com
password abc123

`‑‑config` コマンドオプションを使用する

‑‑config オプションでは、provision コマンドで生成された構成ファイルの場所を指定します。このオプションには、CLI によって構成ファイルから pull される他のほとんどのコマンドパラメータをスキップできるという利点があります。たとえば、次のようなオプションがあります。

organization
environment
runtime
management
insecure
namespace
legacy
opdk

たとえば、次のような provision コマンドを実行できます。

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

構成ファイル

このセクションでは、使用可能なすべてのオプションを含む構成ファイルの例を示します。

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true

リファレンス

バインディング一覧表示コマンド

使用法

パラメータ

例

出力例

ヘルプコマンド

プロビジョニング コマンド

使用法

パラメータ

例

サンプル コマンド

サンプル構成ファイルを作成する

使用法

説明

パラメータ

例

利用可能なテンプレート オプションを一覧表示する

使用法

パラメータ

例

トークン コマンド

JWT トークンを作成する

使用法

パラメータ

例

出力

JWT トークンを検査する

使用法

パラメータ

パラメータ

例

出力

JWT トークンをローテーションする

使用法

パラメータ

例

出力

内部トークンを作成する

使用法

パラメータ

パラメータ

バージョン コマンド

認証情報に .netrc を使用する

‑‑config コマンド オプションを使用する

構成ファイル

プロビジョニングコマンド

サンプルコマンド

利用可能なテンプレートオプションを一覧表示する

トークンコマンド

バージョンコマンド

`‑‑config` コマンドオプションを使用する