Amazon API Gateway
開発者ガイド

Canary リリースを無効にする

Canary リリースのデプロイを無効にするには、canarySettings を null に設定しステージから削除します。

Canary リリースのデプロイを無効にするには、API Gateway コンソール、AWS CLI、または AWS SDK を使用します。

API Gateway コンソールを使用して Canary リリースを無効にする

API Gateway コンソールを使用して Canary リリースのデプロイを無効にするには、以下のステップを使用します。

  1. API Gateway コンソールにサインインし、プライマリナビゲーションペインで既存の API を選択します。

  2. API の下にある [ステージ] を選択し、[ステージ] リストの下にある既存のステージを選択して [ステージエディタ] を開きます。

  3. [設定] の [Canary] タブを選択します。

  4. [Canary の削除] を選択します。

  5. [削除] を選択して Canary を削除することを確認します。

その結果、canarySettings プロパティは null となりデプロイステージから削除されます。AWS CLI を使用してこれを検証できます。例については、「AWS CLI を使用して Canary リリースを無効にする」を参照してください。

AWS CLI を使用して Canary リリースを無効にする

AWS CLI を使用して Canary リリースのデプロイを無効にするには、以下のように update-stage コマンドを呼び出します。

aws apigateway update-stage \ --rest-api-id 4wk1k4onj3 \ --stage-name canary \ --patch-operations '["op":"remove", "path":"/canarySettings"]'

レスポンスが成功すると、次のようなペイロードを返します。

{ "stageName": "prod", "accessLogSettings": { ... }, "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "deploymentId": "nfcn0x", "lastUpdatedDate": 1511309280, "createdDate": 1511152939, "methodSettings": { ... } }

出力で示されているように、canarySettings プロパティは、Canary が無効なデプロイのステージには存在しなくなりました。