このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge のドキュメントを表示します。
gcloud apigee CLI では、次のことができます。
- API プロキシの表示
- API プロダクトの作成と管理
- API プロキシのデプロイとデプロイ解除、デプロイの詳細の表示
- デベロッパーとアプリに関する情報の表示
- 環境と組織の一覧表示
- Apigee API プロキシを呼び出すサードパーティ アプリケーションの管理
さらに、gcloud beta apigee CLI により、Apigee 環境にアーカイブをデプロイして管理できます。
以下のセクションでは、gcloud apigee と gcloud beta apigee の CLI をインストール、承認、使用する方法、および必要に応じて環境変数を設定する方法について説明します。
始める前に
Google Cloud SDK のインストールをはじめとして、Apigee を使用するための前提条件を満たしていることを確認します。
gcloud ベータ版 apigee コンポーネントをインストールする
gcloud beta apigee コマンドにアクセスするには、次のように完全な gcloud のベータ版のコンポーネントをインストールする必要があります。
gcloud components install beta
ベータ版のコンポーネントがインストールされていることを確認するには、次のコマンドを入力します。
gcloud components list
次のようにベータ版コンポーネントがリストに表示されます。
| ステータス | 名前 | ID | サイズ |
|---|---|---|---|
| インストール済み | gcloud Beta コマンド | ベータ版 | < 1 MiB |
詳しくは、SDK コンポーネントの管理をご覧ください。
gcloud へのアクセスの承認
Cloud SDK ツールの承認に記載された手順に沿って、gloud CLI へのアクセスを承認します。
たとえば、ユーザー アカウントを使用してアクセスを承認し、Cloud SDK のその他の一般的な設定手順を実行するには、次のコマンドを使用します。
gcloud init
Cloud SDK の初期化の説明のとおりに、プロンプトに従って、アカウントを認証し、アクセス権限を付与して、Cloud SDK のインストールを初期化します。
追加の設定を行わずにアクセスを承認するには、次のコマンドを使用します。
gcloud auth login
ブラウザベースの承認フローに従ってアカウントを認証し、アクセス権限を付与します。
gcloud CLI へのアクセスの認可と取り消しの詳細については、認証情報をご覧ください。
gcloud コマンドの環境変数の設定
このドキュメントで説明する Apigee API と gcloud CLI の例では、次の表で定義されている環境変数を 1 つ以上使用しています。
前もって環境変数を環境内でわかりやすい値に設定することで、変更をまったくしないか最小限にとどめ、サンプル リクエストをコピー＆ペーストして独自の環境で実行できます。
| 環境変数 | 説明 |
|---|---|
$API |
API プロキシの名前。 |
$APIPRODUCT |
API プロダクトの名前。 |
$APP |
アプリの ID。 |
$DEVELOPER_EMAIL |
デベロッパーのメールアドレス。 |
$ENV |
環境の名前（test、prod など）。 |
$ID |
リソース ID。 |
$KEY |
コンシューマ キー。 |
$NAME |
リソースの名前。 |
$ORG |
Apigee 組織。 |
$REV |
API プロキシのリビジョン番号。 |
$SHAREDFLOW |
共有フローの名前。 |
$TYPE |
リソースタイプ。 |
gcloud CLI の使用
次のように gcloud CLI を使用します。
gcloud apigee GROUP [GCLOUD_WIDE_FLAG …]
使用可能なコマンド グループとフラグの詳細については、gcloud apigee をご覧ください。
たとえば、次のコマンドにより組織内の API プロキシが一覧表示されます。
gcloud apigee apis list --organization=$ORG
以下に、my-org 組織に対するレスポンスの例を示します。
Using Apigee organization `myorg` - hello-world - weather-app
詳細
詳しくは以下をご覧ください。