Come posso usare un runbook SAW per risolvere gli errori di richiamo HTTP del Gateway API?

Breve descrizione

Il runbook AWSSupport-TroubleshootApiGatewayHttpErrors fornisce una soluzione automatizzata per trovare e risolvere gli errori derivanti dalle richieste HTTP del Gateway API. Quando l’API è configurata per registrare tutte le richieste riguardanti risorse e metodi, puoi utilizzare questo runbook per risolvere gli errori 4xx e 5xx.

Per ulteriori informazioni su come configurare la registrazione, fare riferimento a Configurazione della registrazione di CloudWatch per un REST API nel Gateway API.

Per ulteriori informazioni su SAW, consulta Flusso di lavoro dell'automazione del supporto AWS (SAW).

Risoluzione

Il runbook AWSSupport-TroubleshootApiGatewayHttpErrors convalida l'API, la risorsa, il metodo e la fase prima di tentare di recuperare e analizzare i file di log Amazon CloudWatch.

L'utente corrente o il presunto ruolo di servizio AWS Identity and Access Management (IAM) che esegue l'automazione deve disporre delle seguenti autorizzazioni:

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

Prerequisiti

Prima di eseguire il runbook, assicurati che l’utente o il ruolo IAM dispongano delle autorizzazioni corrette. Queste autorizzazioni includono specifiche autorizzazioni di AWS Systems Manager e autorizzazioni aggiuntive specifiche per i servizi descritte nelle sezioni precedenti di questo articolo.

Esegui l'automazione AWSSupport-TroubleshootApiGatewayHttpErrors

1. Apri il runbook AWSSupport-TroubleshootApiGatewayHttpErrors.
   **Nota:**Il runbook si trova nella regione AWS us-east-1.

2. Seleziona Esegui automazione.

   Per i parametri di input, inserire quanto segue:

   • **RestApiId (obbligatorio):**L'ID API per l'API che richiede la risoluzione dei problemi.
   • **StageName (obbligatorio):**Il nome della fase implementata.
   • **ResourcePath (obbligatorio):**Il percorso delle risorse del metodo.
   • **HttpMethod (obbligatorio):**Il metodo per il percorso delle risorse configurato.
   • **StartTime (obbligatorio):**La data e l'ora di inizio per l'interrogazione dei log CloudWatch. Il formato deve essere aaaa-MM-GGTHH:mm:ss e il fuso orario deve essere UTC.
   • **EndTime (obbligatorio):**La data e l'ora di fine per l'interrogazione dei log CloudWatch. Il formato deve essere aaaa-MM-GGTHH:mm:ss e il fuso orario deve essere UTC.
   • **AccessLogs (obbligatorio):**Fornire informazioni sull'eventuale analisi dei log di accesso.
   • **ExecutionId (opzionale):**L'ID di esecuzione della richiesta che presenta errori.
   • **AutomationAssumeRole (opzionale):**Il nome della risorsa Amazon (ARN) del ruolo IAM che consente ad Automation una funzionalità di Systems Manager, per eseguire le azioni per proprio conto. Se non viene specificato alcun ruolo, Automation utilizza le autorizzazioni dell'utente che avvia il runbook.

3. Seleziona Esegui. Inizia l'automazione.

4. Al termine dell'automazione, consulta la sezione Output per risultati dettagliati.

**Nota:**Il runbook viene completato correttamente, anche se non viene trovato alcun log.