¿Cómo puedo usar un runbook de SAW para solucionar los errores de invocación HTTP de API Gateway?

Breve descripción

El runbook de AWSSupport-TroubleshootAPIGatewayHttpErrors proporciona una solución automatizada para encontrar y solucionar los errores que surgen de las solicitudes HTTP de API Gateway. Cuando su API esté configurada para registrar todas las solicitudes de recursos y métodos, puede usar este manual para solucionar los errores 4xx y 5xx.

Para obtener más información sobre cómo configurar el registro, consulte Configuración del registro de CloudWatch para una API de REST en API Gateway.

Para obtener más información sobre SAW, consulte Flujos de trabajo de automatización de AWS Support (SAW).

Resolución

El runbook de AWSSupport-TroubleSapiGatewayHttpErrors valida la API, el recurso, el método y el escenario antes de intentar recuperar y analizar los registros de Amazon CloudWatch.

El usuario actual o el rol de servicio de AWS Identity and Access Management (IAM) asumido que ejecuta la automatización debe tener los siguientes permisos:

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

Requisitos previos

Antes de ejecutar el runbook, asegúrese de que su usuario o rol de IAM tiene los permisos correctos. Estos permisos incluyen los permisos específicos de AWS Systems Manager y los permisos adicionales específicos de los servicios que se describen en las secciones anteriores de este artículo.

Ejecute la automatización de AWSSupport-TroubleshootAPIGatewayHttpErrors

1. Abra el runbook de AWSSupport-TroubleshootAPIGatewayHttpErrors.
   Nota: El runbook se encuentra en la región de AWS us-east-1.

2. Seleccione Ejecutar automatización.

   Para los parámetros de entrada, introduzca lo siguiente:

   • RestApiID (obligatorio): El ID de API de la API que requiere la solución de problemas.
   • StageName (obligatorio): El nombre de la etapa implementada.
   • ResourcePath (obligatorio): La ruta de recursos del método.
   • HttpMethod (obligatorio): El método para la ruta de recursos configurada.
   • StartTime (obligatorio): La fecha y la hora de inicio para consultar los registros de CloudWatch. El formato debe ser aaaa-MM-ddTHH:mm:ss y la zona horaria debe ser UTC.
   • EndTime (obligatorio): La fecha y hora de finalización para consultar los registros de CloudWatch. El formato debe ser aaaa-MM-ddTHH:mm:ss y la zona horaria debe ser UTC.
   • AccessLogs (obligatorio): Proporcione información sobre si se analizan los registros de acceso.
   • ExecutionId (opcional): El ID de ejecución de la solicitud en la que se producen errores.
   • AutomationAssumeRole (opcional): El nombre de recurso de Amazon (ARN) del rol de IAM que permite a automatización, una función de Systems Manager, para realizar las acciones en su nombre. Si no se especifica ningún rol, la automatización usa los permisos del usuario que inicia el runbook.

3. Seleccione Ejecutar. Se inicia la automatización.

4. Una vez finalizada la automatización, revise la sección Resultados para obtener resultados detallados.

Nota: El runbook se completa correctamente, incluso si no se encuentra ningún registro.