REST 또는 HTTP API용 API 게이트웨이 기본 엔드포인트를 비활성화하려면 어떻게 해야 하나요?

2분 분량

클라이언트가 사용자 지정 도메인 이름만으로 API를 호출할 수 있도록 허용하고 싶습니다.

간략한 설명

Amazon API Gateway REST API 및 HTTP API는 https://API_ID.execute-api.REGION.amazonaws.com 형식의 기본 API 엔드포인트를 사용합니다. API Gateway REST 또는 HTTP API에 사용자 지정 도메인 이름을 사용하는 경우, 기본 엔드포인트를 비활성화할 수 있습니다. 이렇게 하면 모든 트래픽이 사용자 지정 도메인 이름을 통해 API로 라우팅됩니다.

해결 방법

기본 엔드포인트를 비활성화하려면 API 게이트웨이 콘솔, AWS Command Line Interface(AWS CLI) 또는 AWS CloudFormation을 사용하세요. 기본 엔드포인트를 비활성화한 후 업데이트를 적용하려면 배포를 시작해야 합니다.

참고: AWS CLI 명령을 실행할 때 오류가 발생하면 최신 버전의 AWS CLI를 사용하고 있는지 확인하세요.

API 게이트웨이 콘솔

REST API

API 게이트웨이 콘솔을 엽니다.
탐색 창에서 API를 선택한 다음 REST API를 선택합니다.
탐색 창에서 설정을 선택합니다.
기본 엔드포인트의 경우, 비활성을 선택한 다음 변경 사항 저장을 선택합니다.
탐색 창에서 리소스, 작업을 선택한 다음 API 배포를 선택합니다.

HTTP API

API 게이트웨이 콘솔을 엽니다.
탐색 창에서 API를 선택한 다음 HTTP API를 선택합니다.
탐색 창에서 API를 선택합니다. API_NAME(API_ID).
편집을 선택합니다.
기본 엔드포인트의 경우, 비활성을 선택한 다음 저장을 선택합니다.

AWS CLI

REST API
AWS CLI 명령 update-rest-api를 실행합니다.

aws apigateway update-rest-api --rest-api-id abcdef123 --patch-operations op=replace,path=/disableExecuteApiEndpoint,value='True'

업데이트된 API를 배포하려면 AWS CLI 명령 create-deployment를 실행합니다.

aws apigateway create-deployment --rest-api-id abcdef123 --stage-name dev

참고: api-id abcdef123 및 stage_name dev를 REST API ID 및 해당 스테이지로 대체합니다.

HTTP API

AWS CLI 명령 update-api를 실행합니다.

aws apigatewayv2 update-api --api-id abcdef123 --disable-execute-api-endpoint

업데이트된 API를 배포하려면 AWS CLI 명령 create-deployment를 실행합니다.

aws apigatewayv2 create-deployment --api-id abcdef123 --stage-name dev

참고: api_id abcdef123 및 stage_name dev를 HTTP API ID 및 해당 스테이지로 대체합니다.

CloudFormation 템플릿

CloudFormation 템플릿에서 기본 엔드포인트를 비활성화하려면 DisableExecuteApiEndpoint 파라미터를 True로 설정합니다. REST API 또는 HTTP API용 CloudFormation 템플릿을 업데이트하세요.

중요: 기본 엔드포인트 URL을 사용하여 API를 호출하는 경우, 기본 엔드포인트를 비활성화하면 오류가 발생합니다. REST API에 대한 HTTP 403 Forbidden 오류 또는 HTTP API의 경우, HTTP 404 Not Found 오류가 발생합니다.