SAW 런북을 사용하여 API Gateway HTTP 호출 오류 문제를 해결하려면 어떻게 해야 하나요?

간략한 설명

AWSSupport-TroubleshootAPIGatewayHttpErrors 런북은 API Gateway HTTP 요청에서 발생하는 오류를 찾아 해결하기 위한 자동화된 솔루션을 제공합니다. API가 모든 리소스 및 메서드 요청을 기록하도록 구성되면 이 런북을 사용하여 4xx 및 5xx 오류를 해결할 수 있습니다.

로깅을 설정하는 방법에 대한 자세한 내용은 API Gateway에서 REST API에 대한 CloudWatch 로깅 설정을 참조하세요.

SAW에 대한 자세한 내용은 AWS Support Automation Workflows(SAW)를 참조하세요.

해결 방법

AWSSupport-TroubleshootAPIGatewayHttpErrors 런북은 Amazon CloudWatch Logs를 검색하고 분석하기 전에 API, 리소스, 메서드 및 스테이지를 검증합니다.

자동화를 실행하는 현재 사용자 또는 위임된 AWS Identity and Access Management(IAM) 서비스 역할에는 다음 권한이 있어야 합니다.

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

사전 조건

런북을 실행하기 전에, IAM 사용자 또는 역할에 올바른 권한이 있는지 확인하세요. 이러한 권한에는 특정 AWS Systems Manager 권한과 이 문서의 이전 섹션에서 다룬 추가 서비스별 권한이 포함됩니다.

AWSSupport-TroubleshootAPIGatewayHttpErrors 자동화 실행

1. AWSSupport-TroubleshootAPIGatewayHttpErrors 런북을 여세요.
   참고: 런북은 us-east-1 AWS 리전에 있습니다.

2. Execute automation(자동화 실행)을 선택하세요.

   입력 파라미터에 다음을 입력하세요.

   • RestApiId(필수): 문제 해결이 필요한 API의 API ID입니다.
   • StageName(필수): 배포된 스테이지의 이름입니다.
   • ResourcePath(필수): 메서드의 리소스 경로입니다.
   • HttpMethod(필수): 구성된 리소스 경로의 메서드입니다.
   • StartTime(필수): CloudWatch Logs 쿼리를 시작한 날짜 및 시간입니다. 형식은 yyyy-MM-ddTHH:mm:ss여야 하며 시간대는 UTC여야 합니다.
   • EndTime(필수): CloudWatch Logs 쿼리를 종료한 날짜 및 시간입니다. 형식은 yyyy-MM-ddTHH:mm:ss여야 하며 시간대는 UTC여야 합니다.
   • AccessLogs(필수): 액세스 로그의 분석 여부에 대한 정보를 제공합니다.
   • ExecutionId(선택 사항): 오류가 발생한 요청의 실행 ID입니다.
   • AutomationAssumeRole(선택 사항): 이는 Systems Manager의 기능인 자동화가 사용자를 대신하여 작업을 수행할 수 있도록 허용하는 IAM 역할의 Amazon 리소스 이름(ARN)입니다. 역할이 지정되지 않은 경우, 자동화는 런북을 시작한 사용자의 권한을 사용합니다.

3. Execute(실행)을 선택하세요. 자동화가 시작됩니다.

4. 자동화가 완료되면 Outputs(출력) 섹션을 검토하여 자세한 결과를 확인하세요.

참고: 로그를 찾을 수 없더라도 런북이 성공적으로 완료됩니다.