API プロキシのデプロイ解除

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

以降のセクションで説明するように、クラスタから API プロキシリビジョンのデプロイを解除します。

リビジョンのデプロイを解除する場合は、次の点に注意してください。

Apigee では、以前にデプロイされたリビジョンにはロールバックされません。
デプロイを解除すると、その API プロキシのリビジョンが環境にデプロイされていない状態になります。

API プロキシのデプロイ解除は、API プロキシの削除と似ていますが、リビジョンのデプロイ解除は UI で編集して後で再デプロイできる点が異なります。API プロキシは、削除すると編集できなくなります。

新しいプロキシエディタ

UI を使用して API プロキシのデプロイを解除するには:

Cloud コンソールの Apigee UI を使用している場合: [プロキシ開発] > [API プロキシ] を選択します。

従来の Apigee UI を使用している場合: [Develop] > [API Proxies] を選択して、[プロキシ] ペインでプロキシの環境を選択します。
デプロイを解除する API プロキシを選択します。API プロキシの [概要] ビューが UI に表示されます。
[ステータス] 列のアイコンにカーソルを合わせ、[デプロイ解除] を選択します。

従来のプロキシエディタ

UI を使用して API プロキシのデプロイを解除するには:

Apigee UI にログインします。
[Develop] > [API Proxies] の順に選択します。
選択した環境の現在の API プロキシのリストが UI に表示されます。
デプロイを解除する API プロキシを選択します。

API プロキシの [Overview] ビューが UI に表示されます。
目的の環境の行で [Revision] プルダウンリストを開き、[Undeploy] を選択します。

デプロイを解除するバージョンを確認する UI が表示されます。
[Undeploy] をクリックします。
ステータスが更新され、リビジョンがクラスタからデプロイ解除されたことが示されます。

ただし、デプロイ解除プロセスはしばらく時間がかかる場合があります（結果整合性モデル）。実際には [Undeploy] をクリックすると、Apigee により、クラスタ内の環境から選択したリビジョンのデプロイを解除するプロセスが開始されます。

デプロイされていないプロキシのステータスを確認する方法については、デプロイステータスの表示をご覧ください。

または、[Develop] タブで編集中のリビジョンのデプロイを解除することもできます。

[Deploy to: env_name] プルダウンリストをクリックします。

UI に環境のリストが表示されます。[Revision] 列に、現在デプロイされているリビジョン（ない場合はダッシュ）が表示され、[Deploy revision] ボタンと [Undeploy] ボタンを選択するよう求められます。
目的の環境の [Undeploy] ボタンをクリックします。
デプロイを解除するバージョンを確認する UI が表示されます。
[Undeploy] ボタンをクリックします。
UI でステータスが更新され、リビジョンのデプロイが解除されたことが示されます。ただし、デプロイ解除プロセスはしばらく時間がかかる場合があります（結果整合性モデルの場合）。[Undeploy] をクリックすると、選択したリビジョンをその環境からデプロイ解除するプロセスが開始されます。

Apigee API

API プロキシのデプロイを解除するには、次の API 呼び出しを使用します。

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

ここで、OAuth 2.0 アクセストークンの取得で説明されているように、$TOKEN は OAuth 2.0 アクセストークンに設定されます。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。使用される環境変数の説明については、Apigee API リクエストの環境変数の設定をご覧ください。

次に、レスポンスの出力例（空のレスポンス）を示します。

{}

詳細については、API プロキシリビジョン API のデプロイ解除をご覧ください。

gcloud

以降のセクションでは、gcloud alpha apigee CLI コマンドを使用して API プロキシリビジョンのデプロイ解除とデプロイ解除の検証を行う例を示します。

gcloud CLI を使用した API プロキシリビジョンのデプロイ解除
gcloud CLI を使用した API プロキシリビジョンのデプロイ解除の検証

サンプルで使用されている環境変数の詳細と説明については、Apigee で gcloud を使用するをご覧ください。

gcloud CLI を使用した API プロキシリビジョンのデプロイ解除

API プロキシリビジョンのデプロイを解除するには、次の gcloud コマンドを使用します。

gcloud alpha apigee apis undeploy $REV --api=$API --environment=$ENV

レスポンスの例を次に示します。

Using Apigee organization `my-org`

gcloud CLI を使用した API プロキシリビジョンのデプロイ解除の検証

API プロキシリビジョンが環境からデプロイ解除されていることを確認するには、次の gcloud コマンドを使用します。

gcloud alpha apigee deployments list --api=$API --environment=$ENV

レスポンスの例を次に示します。

Using Apigee organization `my-org`
Listed 0 items.

詳しくは、CLI によってデプロイを一覧表示する方法をご覧ください。

API プロキシのデプロイ解除

新しいプロキシ エディタ

従来のプロキシ エディタ