View a markdown version of this page

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig - AWS Systems Manager Runbook-Referenz für Automation

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig

Beschreibung

Das AWSSupport-TroubleshootAPIGatewayCustomDomainConfig Runbook hilft Ihnen dabei, Probleme mit Ihrer benutzerdefinierten Domainnamenkonfiguration in Amazon API Gateway zu identifizieren. Das Runbook analysiert die folgenden Konfigurationsschritte:

  • Ein benutzerdefinierter Domainname wird in API Gateway erstellt.

  • Zwischen dem benutzerdefinierten Domainnamen und der betreffenden API besteht eine Zuordnung.

  • Für den benutzerdefinierten Domainnamen ist ein DNS-Eintrag vorhanden, der auf das richtige Ziel verweist.

Wichtig

Dieses Runbook unterstützt nicht die Behebung von mTLS-Problemen mit benutzerdefinierten API-Gateway-Domainnamen.

Wichtig

Dieses Runbook unterstützt nur die Fehlerbehebung bei öffentlich auflösbaren benutzerdefinierten Domainnamen.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

/

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

  • apigateway:GET

  • route53:ListResourceRecordSets

Beispiel für eine IAM-Richtlinie:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "apigateway:GET",
                "route53:ListResourceRecordSets"
            ],
            "Resource": "*"
        }
    ]
}
Anmerkung

Der IAM-Benutzer oder die IAM-Rolle, der das Runbook startet, erfordert die folgenden Aktionen:

  • iam:ListRoles

  • iam:PassRole

  • ssm:DescribeAutomationExecutions

  • ssm:DescribeAutomationStepExecutions

  • ssm:DescribeDocument

  • ssm:GetAutomationExecution

  • ssm:GetDocument

  • ssm:ListDocuments

  • ssm:StartAutomationExecution

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-TroubleshootAPIGatewayCustomDomainConfig im Systems Manager unter Dokumente zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Fakultativ):

      Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen auszuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • DomainName (Erforderlich):

      Der benutzerdefinierte Domainname, der für Ihre Amazon API Gateway-API erstellt wurde.

    • ApiId (Erforderlich):

      Die API-ID Ihres API-Gateways.

    • DNSServerIp (Fakultativ):

      IPv4-Adresse eines DNS-Servers zur Auflösung des benutzerdefinierten Domainnamens und des API Gateway-Domänennamens. Wenn kein Wert angegeben wird, wird der AWS DNS-Server (169.254.169.253) verwendet.

    • HostedZoneId (Fakultativ):

      Die Public Hosted Zone-ID, mit der der DNS-Eintrag für den benutzerdefinierten Domainnamen in Amazon Route 53 erstellt wird. Wenn Route 53 nicht für DNS verwendet wird, ist der Wert nicht erforderlich.

  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

  6. Das Dokument führt die folgenden Schritte aus:

    • CheckAPIExists:

      Überprüft das Vorhandensein der Amazon API Gateway API.

    • GetDomainName:

      Ruft Details für den in Amazon API Gateway konfigurierten benutzerdefinierten Domainnamen ab.

    • GetMappings:

      Ruft alle Amazon API Gateway-API-Zuordnungen ab, die für den benutzerdefinierten Domainnamen konfiguriert wurden, und überprüft, ob die angegebene API-ID über eine gültige Zuordnung mit den richtigen Stufen- und Pfadkonfigurationen verfügt.

    • CheckDNSRecordExists:

      Überprüft das DNS des benutzerdefinierten Domainnamens und gibt die zugehörigen Datensätze zurück.

    • ValidateDNSResults:

      Vergleicht die DNS-Details (A- oder CNAME-Einträge) des benutzerdefinierten Domainnamens, um sicherzustellen, dass der Datensatz auf den richtigen Amazon API Gateway-Vertriebsdomänennamen verweist.

    • Results:

      Formatiert die Gesamtausgabe von Systems Manager Automation so, dass eine strukturierte Zusammenfassung der Analyseergebnisse der benutzerdefinierten Domänenkonfiguration an die Systems Manager-Konsole zurückgegeben wird.

  7. Nach Abschluss des Vorgangs finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung.

Referenzen

Systems Manager Automation