View a markdown version of this page

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig - AWS Systems Manager Référence du dossier d’exploitation Automation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWSSupport-TroubleshootAPIGatewayCustomDomainConfig

Description

Le AWSSupport-TroubleshootAPIGatewayCustomDomainConfig runbook vous aide à identifier les problèmes liés à la configuration de votre nom de domaine personnalisé dans Amazon API Gateway. Le runbook analyse les étapes de configuration suivantes :

  • Un nom de domaine personnalisé est créé dans API Gateway.

  • Un mappage existe entre le nom de domaine personnalisé et l'API en question.

  • Un enregistrement DNS existe pour le nom de domaine personnalisé et pointe vers la bonne cible.

Important

Ce runbook ne permet pas de résoudre les problèmes mTLS liés aux noms de domaine personnalisés d'API Gateway.

Important

Ce runbook permet uniquement de résoudre les problèmes liés aux noms de domaine personnalisés pouvant être résolus publiquement.

Exécutez cette automatisation (console)

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

/

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

  • apigateway:GET

  • route53:ListResourceRecordSets

Exemple de politique IAM :


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

L'utilisateur ou le rôle IAM qui démarre le runbook nécessite les actions suivantes :

  • iam:ListRoles

  • iam:PassRole

  • ssm:DescribeAutomationExecutions

  • ssm:DescribeAutomationStepExecutions

  • ssm:DescribeDocument

  • ssm:GetAutomationExecution

  • ssm:GetDocument

  • ssm:ListDocuments

  • ssm:StartAutomationExecution

Instructions

Pour configurer l'automatisation, procédez comme suit :

  1. Accédez à AWSSupport-TroubleshootAPIGatewayCustomDomainConfig la section Documents dans Systems Manager.

  2. Sélectionnez Execute automation (Exécuter l'automatisation).

  3. Pour les paramètres d'entrée, entrez les informations suivantes :

    • AutomationAssumeRole (Facultatif) :

      Le nom de ressource Amazon (ARN) du rôle IAM qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui démarre ce runbook.

    • DomainName (Obligatoire) :

      Le nom de domaine personnalisé créé pour votre API Amazon API Gateway.

    • ApiId (Obligatoire) :

      L'ID d'API de votre passerelle API.

    • DNSServerIp (Facultatif) :

      Adresse IPv4 d'un serveur DNS pour résoudre le nom de domaine personnalisé et le nom de domaine API Gateway. Si aucune valeur n'est spécifiée, le serveur AWS DNS (169.254.169.253) sera utilisé.

    • HostedZoneId (Facultatif) :

      L'ID de zone hébergée publique où l'enregistrement DNS du nom de domaine personnalisé est créé dans Amazon Route 53. Si Route 53 n'est pas utilisée pour le DNS, la valeur n'est pas obligatoire.

  4. Sélectionnez Exécuter.

  5. L'automatisation démarre.

  6. Le document exécute les étapes suivantes :

    • CheckAPIExists:

      Vérifie l'existence de l'API Amazon API Gateway.

    • GetDomainName:

      Obtient les détails du nom de domaine personnalisé configuré dans Amazon API Gateway.

    • GetMappings:

      Récupère tous les mappages d'API Amazon API Gateway configurés pour le nom de domaine personnalisé et vérifie si l'ID d'API spécifié possède un mappage valide avec les configurations d'étape et de chemin correctes.

    • CheckDNSRecordExists:

      Vérifie le DNS du nom de domaine personnalisé et renvoie les enregistrements associés.

    • ValidateDNSResults:

      Compare les informations DNS (enregistrements A ou CNAME) du nom de domaine personnalisé pour s'assurer que l'enregistrement pointe vers le nom de domaine de distribution Amazon API Gateway correct.

    • Results:

      Formate la sortie globale de Systems Manager Automation pour renvoyer un résumé structuré des résultats de l'analyse de configuration de domaine personnalisé à la console Systems Manager.

  7. Une fois l'exécution terminée, consultez la section Sorties pour obtenir les résultats détaillés de l'exécution.

Références

Systems Manager Automation