メニュー
Amazon API Gateway
開発者ガイド

Canary リリースを無効にする

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

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

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

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

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

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

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

  4. [Delete Canary] を選択します。

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

その結果、canarySettings プロパティは null となりデプロイステージから削除されます。これを確認するには、AWS CLI または API Gateway REST API を使用します。たとえば、AWS CLI を使用して Canary リリースを無効にする または API Gateway REST API を使用して 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"]'

The successful response returns an output similar to this:

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

As shown in the output, the canarySettings property is no longer present in the stage of a canary-disabled deployment.

API Gateway REST API を使用して Canary リリースを無効にする

API Gateway REST API を使用して Canary リリースのデプロイを無効にするには、以下のように stage:update リクエストを使用します。

PATCH /restapis/4wk1k4onj3/stages/prod HTTP/1.1 Host: apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20171121T230325Z Authorization: AWS4-HMAC-SHA256 Credential={SECRET_ACCESS_KEY}/20171121/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={SIGV4_SIGNATURE} { "patchOperations": [ { "op": "remove", "path": "/canarySettings" } ] }

The successful response returns an output similar to this:

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

As shown in the output, the canarySettings property is no longer present in the stage of a canary-disabled deployment.