Canary リリースをオフにする

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

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

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

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

Old REST API console

注記

API Gateway コンソールの設計を変更しました。古いコンソールエクスペリエンスは、2023 年 11 月下旬から利用できなくなります。

Canary リリースのデプロイをオフにするには

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

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

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

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

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

New REST API console

Canary リリースのデプロイをオフにするには

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

2. メインナビゲーションペインで、[ステージ] を選択してから、既存のステージを選択します。

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

4. [Delete] (削除) をクリックします。

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 が無効なデプロイのステージには存在しなくなりました。