Como posso usar um runbook SAW para solucionar erros de invocação HTTP do API Gateway?

Breve descrição

O runbook AWSSupport-TroubleshootAPIGatewayHttpErrors fornece uma solução automatizada para localizar e solucionar erros decorrentes de solicitações HTTP do API Gateway. Quando sua API está configurada para registrar todas as solicitações de recursos e métodos, você pode usar esse runbook para solucionar erros 4xx e 5xx.

Para mais informações sobre como configurar o registro em log, consulte Configurar o registro em log do CloudWatch para uma API REST no API Gateway.

Para obter mais informações sobre o SAW, consulte Fluxos de trabalho de automação de suporte da AWS (SAW).

Resolução

O runbook AWSSupport-TroubleshootApiGatewayHttpErrors valida a API, o recurso, o método e o estágio antes de tentar recuperar e analisar os registros do Amazon CloudWatch.

O usuário atual ou a função de serviço assumida do AWS Identity and Access Management (IAM) que executa a automação deve ter as seguintes permissões:

• apigateway:GET
• logs:GetQueryResults
• logs:StartQuery
• ssm:DescribeAutomationExecutions
• ssm:GetAutomationExecution
• ssm:DescribeAutomationStepExecutions
• ssm:StartAutomationExecution
• ssm:DescribeDocument
• ssm:GetDocument
• ssm:ListDocuments

Pré-requisitos

Antes de executar o runbook, certifique-se de que seu usuário ou perfil do IAM tenha as permissões corretas. Essas permissões incluem permissões específicas do AWS Systems Manager e as permissões adicionais específicas dos serviços abordadas nas seções anteriores deste artigo.

Executar a automação AWSSupport-TroubleshootAPIGatewayHttpErrors

1. Abra o runbook AWSSupport-TroubleshootAPIGatewayHttpErrors.
   Observação: o runbook está na região us-east-1 da AWS.

2. Selecione Executar automação.

   Para parâmetros de entrada, insira o seguinte:

   • RestApiId (obrigatório): o ID da API que requer solução de problemas.
   • StageName (obrigatório): o nome do estágio implantado.
   • ResourcePath (obrigatório): o caminho do recurso do método.
   • HttpMethod (obrigatório): o método para o caminho do recurso configurado.
   • StartTime (obrigatório): a data e a hora de início da consulta do CloudWatch Logs. O formato deve ser aaaa-MM-ddTHH:mm:ss e o fuso horário deve ser UTC.
   • EndTime (obrigatório): a data e a hora de término da consulta aos registros do CloudWatch. O formato deve ser aaaa-MM-ddTHH:mm:ss e o fuso horário deve ser UTC.
   • AccessLogs (obrigatório): forneça informações sobre se os registros de acesso são analisados.
   • ExecutionId (opcional): o ID de execução da solicitação que apresenta erros.
   • AutomationAssumeRole (opcional): o Amazon Resource Name (ARN) da função do IAM que permite que a Automation, um recurso do Systems Manager, realize as ações em seu nome. Se nenhuma função for especificada, a Automação usará as permissões do usuário que inicia o runbook.

3. Selecione Executar. A automação é iniciada.

4. Depois que a automação terminar, revise a seção Saídas para obter resultados detalhados.

Observação: o runbook é concluído com êxito, mesmo que nenhum registro seja encontrado.