View a markdown version of this page

AWSSupport-TroubleshootAPIGatewayHttpErrors - AWS Systems Manager Referencia del manual de procedimientos de Automatización

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWSSupport-TroubleshootAPIGatewayHttpErrors

Descripción

El AWSSupport-TroubleshootAPIGatewayHttpErrors manual ayuda a solucionar los 5XX/4XX errores que se producen al invocar una API REST de Amazon API Gateway implementada, ya que analiza los registros de and/or ejecución de los accesos y analiza los errores para proporcionar los pasos necesarios para corregirlos a través de la documentación y los artículos de re:post. AWS

importante

Este manual tiene las siguientes limitaciones:

importante

El uso de este manual puede generar cargos adicionales en su AWS cuenta por los CloudWatch registros de Amazon capturados por su API REST y CloudWatch los registros de información utilizados en el análisis. Consulta los CloudWatch precios de Amazon para obtener más información sobre los cargos en los que se puede incurrir. Si el aws:deletestack paso no funciona, ve a la CloudFormation consola para eliminar la pila manualmente. El nombre de la pila creado por este manual de procedimientos comienza por AWSSupport-TroubleshootAPIGatewayHttpErrors. Para obtener información sobre la eliminación de CloudFormation pilas, consulte Eliminar una pila en la Guía del AWS CloudFormation usuario.

¿Cómo funciona?

El manual lleva a cabo los siguientes pasos de validación y análisis:

  • Comprueba que la API REST especificada existe y que tienes los permisos necesarios.

  • Valida que la etapa especificada exista en la API.

  • Valida que la ruta de recursos especificada exista en la API.

  • Valida que el método HTTP especificado exista para el recurso.

  • Analiza CloudWatch los registros de los parámetros y el intervalo de tiempo especificados para identificar los errores y ofrecer recomendaciones de corrección.

Ejecuta esta automatización (consola)

Tipo de documento

Automatización

Propietario

Amazon

Plataformas

/

Permisos de IAM necesarios

El parámetro AutomationAssumeRole requiere las siguientes acciones para utilizar el manual de procedimientos correctamente.

  • apigateway:GET

  • logs:CreateLogGroup

  • logs:CreateLogStream

  • logs:DescribeLogGroups

  • logs:DescribeLogStreams

  • logs:PutLogEvents

  • logs:StartQuery

  • logs:GetQueryResults

Política de IAM de ejemplo:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "apigateway:GET",
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:DescribeLogGroups",
                "logs:DescribeLogStreams",
                "logs:PutLogEvents",
                "logs:StartQuery",
                "logs:GetQueryResults"
            ],
            "Resource": "*"
        }
    ]
}

Instrucciones

Siga estos pasos para configurar la automatización:

  1. Navegue hasta el Administrador de sistemas, AWSSupport-TroubleshootAPIGatewayHttpErrors en la sección Documentos.

  2. Elija Execute automation (Ejecutar automatización).

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

    • AutomationAssumeRole (Opcional):

      • Descripción: (opcional) El nombre de recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que permite a SSM Automation realizar las acciones en tu nombre. Si no se especifica ningún rol, SSM Automation usa los permisos del usuario que inicia este libro de operaciones.

      • Tipo: AWS::IAM::Role::Arn

    • RestApiId (Obligatorio):

      • Descripción: (Obligatorio) El ID de API de la API que requiere la solución de problemas. Debe ser una cadena alfanumérica de 10 caracteres.

      • Tipo: String

      • Valor permitido: ^[a-zA-Z0-9]{10}$

    • StageName (Obligatorio):

      • Descripción: (Obligatorio) El nombre de la fase implementada. Debe tener entre 1 y 128 caracteres y contener letras, números, guiones bajos o guiones.

      • Tipo: String

      • Valor permitido: ^[a-zA-Z0-9_\\-]{1,128}$

    • ResourcePath (Opcional):

      • Descripción: (opcional) La ruta del recurso para la que está configurado el método. Ejemplos: /, /store/items, /{resource}.

      • Tipo: String

      • Valor predeterminado: /

    • HttpMethod (Opcional):

      • Descripción: (opcional) El método para la ruta de recursos configurada.

      • Tipo: String

      • Valores permitidos: [ANY, DELETE, HEAD, OPTIONS, GET, POST, PUT, PATCH]

      • Valor predeterminado: GET

    • StartTime (Opcional):

      • Descripción: (opcional) La fecha y la hora de inicio de la consulta de los CloudWatch registros. Formato: yyyy-MM-ddTHH:mm:ss en la zona horaria UTC. Si no se especifica, el valor predeterminado es 3 días antes de la hora actual.

      • Tipo: String

      • Valor permitido: ^$|^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$

      • Valor predeterminado: ""

    • EndTime (Opcional):

      • Descripción: (opcional) La fecha y la hora de finalización de la consulta de los CloudWatch registros. Formato: yyyy-MM-ddTHH:mm:ss en la zona horaria UTC. Si no se especifica, el valor predeterminado es la hora actual.

      • Tipo: String

      • Valor permitido: ^$|^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$

      • Valor predeterminado: ""

    • AccessLogs (Opcional):

      • Descripción: (opcional) Si se deben analizar los registros de acceso.

      • Tipo: Boolean

      • Valores permitidos: [true, false]

      • Valor predeterminado: false

    • RequestId (Opcional):

      • Descripción: (opcional) El identificador de solicitud de la solicitud en la que se observó un error. Debe ser un formato de UUID válido.

      • Tipo: String

      • Valor permitido: ^$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      • Valor predeterminado: ""

  4. Seleccione Ejecutar.

  5. Se inicia la automatización.

  6. Este documento realiza los siguientes pasos:

    • CheckApiExists:

      Valida que la API REST proporcionada existe y que tienes los permisos necesarios para acceder a ella.

    • CheckStageExists:

      Valida que el nombre de etapa proporcionado exista en la API dada y recupera la información del grupo de registros de acceso.

    • CheckResourceExists:

      Valida que la ruta de recursos proporcionada exista en la API y recupera el ID del recurso.

    • CheckMethodExists:

      Valida que el método HTTP proporcionado exista para el recurso especificado.

    • AnalyseLogs:

      Busca registros con los parámetros proporcionados y devuelve recomendaciones basadas en los errores encontrados. Este paso analiza los registros de ejecución y acceso (si están habilitados) para identificar los errores 4XX y 5XX y proporciona instrucciones específicas para corregirlos.

  7. Una vez finalizada, revise la sección Resultados para ver los resultados detallados de la ejecución, incluidos el análisis de errores y las recomendaciones para corregirlos.

Referencias

Automatización de Systems Manager