Atualizar uma versão canary

Após uma versão canary ser implantada, ajuste a porcentagem do tráfego canary ou ative ou desative o uso de um cache do estágio para otimizar a performance. Você também pode modificar as variáveis de estágio usadas na versão canary quando o contexto de execução é atualizado. Para fazer essas atualizações, chame a operação stage:update com novos valores em canarySettings.

Você pode atualizar um lançamento canary usando o console do API Gateway, o comando da AWS CLI update-stage ou um SDK da AWS.

Atualizar uma versão canary usando o console do API Gateway

Para usar o console do API Gateway para atualizar as configurações do canary existentes em um estágio, faça o seguinte:

Como atualizar as configurações existentes do canário

1. Faça login no console do API Gateway e selecione uma API REST existente.

2. No painel de navegação principal, selecione Estágios e escolha um estágio existente.

3. Selecione a guia Canário e Editar. Talvez seja necessário escolher o botão de seta para a direita para mostrar a guia Canário.

4. Atualize Solicitar distribuição aumentando ou diminuindo a porcentagem entre 0,0 e 100,0.

5. Marque ou desmarque a caixa de seleção Cache de estágio.

6. Adicione, remova ou modifique as Variáveis de estágio de canário.

7. Escolha Salvar.

Atualizar uma versão canary usando a AWS CLI

Para usar a AWS CLI para atualizar um canary, chame o comando update-stage.

Para ativar ou desativar o uso de um cache do estágio para o canary, chame o comando update-stage, da seguinte forma:

aws apigateway update-stage \
    --rest-api-id {rest-api-id} \
    --stage-name '{stage-name}'  \
    --patch-operations op=replace,path=/canarySettings/useStageCache,value=true

Para ajustar a porcentagem do tráfego do canary, chame update-stage para substituir o valor /canarySettings/percentTraffic no estágio.

aws apigateway update-stage \
    --rest-api-id {rest-api-id} \
    --stage-name '{stage-name}' \
    --patch-operations op=replace,path=/canarySettings/percentTraffic,value=25.0

Para atualizar as variáveis de estágio do canary, incluindo a adição, a substituição ou a remoção de uma variável de estágio do canary:

aws apigateway update-stage  \
    --rest-api-id {rest-api-id} \
    --stage-name '{stage-name}'  \
    --patch-operations '[{                                      
        "op": "replace",                                        
        "path": "/canarySettings/stageVariableOverrides/newVar", 
        "value": "newVal"                                      
      }, { 
        "op": "replace",                                        
        "path": "/canarySettings/stageVariableOverrides/var2",   
        "value": "val4"                                        
      }, {                                                      
        "op": "remove",                                         
        "path": "/canarySettings/stageVariableOverrides/var1"    
      }]'

Você pode atualizar todas acima combinando as operações em um único valor patch-operations:

aws apigateway update-stage  \
    --rest-api-id {rest-api-id} \
    --stage-name '{stage-name}' \
    --patch-operations '[{                                       
        "op": "replace",                                         
        "path": "/canarySettings/percentTraffic",                        
        "value": "20.0"                                          
    }, {                                                         
        "op": "replace",                                         
        "path": "/canarySettings/useStageCache",                        
        "value": "true"                                          
    }, {                                                         
        "op": "remove",                                          
        "path": "/canarySettings/stageVariableOverrides/var1"    
    }, {                                                         
        "op": "replace",                                         
        "path": "/canarySettings/stageVariableOverrides/newVar", 
        "value": "newVal"                                        
    }, {                                                         
        "op": "replace",                                         
        "path": "/canarySettings/stageVariableOverrides/val2",   
        "value": "val4"                                          
      }]'