Désactivation d'une version canary

Pour désactiver le déploiement d'une version canary, vous devez attribuer à canarySettings la valeur null pour la supprimer de l'étape.

Vous pouvez désactiver un déploiement de version Canary à l'aide de la console API Gateway, de la AWS CLI ou d'un kit SDK AWS.

Désactivation d'une version canary à l'aide de la console API Gateway

Pour désactiver le déploiement d'une version canary à l'aide de la console API Gateway, suivez les étapes suivantes :

Désactivation d'un déploiement de version canary

1. Connectez-vous à la console API Gateway et choisissez l'API existante dans le volet de navigation principal.

2. Dans le volet de navigation principal, choisissez Étapes, puis choisissez une étape existante.

3. Choisissez l'onglet Canary.

4. Choisissez Supprimer.

5. Confirmez votre souhait de supprimer la version Canary en choisissant Delete.

Résultat : la propriété canarySettings prend la valeur null et est supprimée de l'étape de déploiement. Vous pouvez le vérifier à l’aide de l AWS CLI. Pour obtenir un exemple, consultez Désactivation d'une version canary à l'aide de l'AWS CLI.

Désactivation d'une version canary à l'aide de l'AWS CLI

Pour désactiver le déploiement d'une version canary à l'aide de l'AWS CLI, appelez la commande update-stage comme suit :

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

Une réponse positive renvoie une charge utile comparable à la suivante :

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

Comme illustré dans la sortie, la propriété canarySettings n'est plus présente dans l'étape d'un déploiement canary désactivé.