Wie kann ich ein SAW-Runbook verwenden, um API-Gateway-HTTP-Aufruffehler zu beheben?

Kurzbeschreibung

Das AWSSupport-TroubleshootAPIGatewayHttpErrors-Runbook bietet eine automatisierte Lösung zum Auffinden und Beheben von Fehlern, die sich aus API-Gateway-HTTP-Anfragen ergeben. Wenn Ihre API so konfiguriert ist, dass alle Ressourcen- und Methodenanfragen protokolliert werden, können Sie dieses Runbook verwenden, um 4xx- und 5xx-Fehler zu beheben.

Weitere Informationen zum Einrichten der Protokollierung finden Sie in Einrichten der CloudWatch-Protokollierung für eine REST-API in API Gateway.

Weitere Informationen zu SAW finden Sie unter AWS Unterstützung von Automatisierungs-Workflows (Support Automation Workflows) (SAW).

Behebung

Das AWSSupport-TroubleshootAPIGatewayHttpErrors-Runbook validiert die API, Ressource, Methode und Phase, bevor versucht wird, Amazon CloudWatch-Protokolle abzurufen und zu analysieren.

Der aktuelle Benutzer oder die angenommene Servicerolle AWS Identity and Access Management (IAM), die die Automatisierung ausführt, muss über die folgenden Berechtigungen verfügen:

• apigateway:GET
• Protokolle:AbrufenvonAbfrageergebnissen
• Protokolle:StartenAbfrage
• ssm:BeschreibenvonAutomatisierungsausführungen
• ssm:AbrufenderAutomatisierungsausführung
• ssm:BeschreibenderAusführungvonAutomatisierungsschritten
• ssm:StartenAutomatisierungsausführung
• ssm:BeschreibenDokument
• ssm:AbrufenDokument
• ssm:AuflistenDokumente

Voraussetzungen

Stellen Sie vor dem Ausführen des Runbooks sicher, dass Ihr IAM-Benutzer oder Ihre IAM-Rolle über die richtigen Berechtigungen verfügt. Zu diesen Berechtigungen gehören spezifische AWS Systems Manager-Berechtigungen und die zusätzlichen servicespezifischen Berechtigungen, die in früheren Abschnitten dieses Artikels behandelt wurden.

Führen Sie die AWSSupport-TroubleshootAPIGatewayHttpError-Automatisierung aus

1. Öffnen Sie das Runbook AWSSupport-TroubleshootAPIGatewayHttpErrors-Runbool.
   **Hinweis:**Das Runbook befindet sich in der AWS-Region us-east-1.

2. Wählen Sie Ausführen Automatisierung aus.

   Geben Sie für Eingabeparameter Folgendes ein:

   • **RestAPIID (erforderlich):**Die API-ID für die API, für die eine Fehlerbehebung erforderlich ist.
   • **StageName (erforderlich):**Der Name der bereitgestellten Phase.
   • **Ressourcen-Pfad (erforderlich):**Der Ressourcenpfad der Methode.
   • **HttpMethod (erforderlich):**Die Methode für den konfigurierten Ressourcenpfad.
   • **StartTime (erforderlich):**Das Startdatum und die Startzeit für die Abfrage der CloudWatch-Protokolle. Das Format muss yyyy-MM-DDTHH:mm:ss sein und die Zeitzone muss UTC sein.
   • **EndTime (erforderlich):**Das Enddatum und die Uhrzeit für die Abfrage der CloudWatch-Protokolle. Das Format muss yyyy-MM-DDTHH:mm:ss sein und die Zeitzone muss UTC sein.
   • **AccessLogs (erforderlich):**Geben Sie Informationen darüber an, ob Zugriffsprotokolle analysiert werden.
   • **ExecutionID (optional):**Die Ausführungs-ID für die Anfrage, bei der Fehler auftreten.
   • **AutomationAssumeRole (optional):**Der Amazon-Ressourcenname (ARN) der IAM-Rolle, der es Automation, einer Funktion von Systems Manager, ermöglicht, die Aktionen in Ihrem Namen auszuführen. Wenn keine Rolle angegeben ist, verwendet Automation die Berechtigungen des Benutzers, der das Runbook startet.

3. Wählen Sie Ausführen. Die Automatisierung wird eingeleitet.

4. Nach Abschluss der Automatisierung finden Sie im Abschnitt Ausgaben detaillierte Ergebnisse.

**Hinweis:**Das Runbook wird erfolgreich abgeschlossen, auch wenn keine Protokolle gefunden wurden.