인터페이스 VPC 엔드포인트를 사용하여 다른 AWS 계정의 API Gateway 프라이빗 REST API에 액세스하려면 어떻게 해야 합니까?

최종 업데이트 날짜: 2022년 09월 16일

인터페이스 VPC 엔드포인트를 사용하여 다른 AWS 계정에 있는 Amazon API Gateway 프라이빗 REST API에 액세스하려고 합니다. 어떻게 설정해야 합니까?

간략한 설명

인터페이스 VPC 엔드포인트를 사용하여 다른 AWS 계정에 있는 Amazon API Gateway 프라이빗 REST API에 액세스하려면 다음을 수행합니다.

  1. 한 계정(계정 A)에서 Amazon Virtual Private Cloud(Amazon VPC)에 인터페이스 엔드포인트를 생성합니다.
  2. 두 번째 계정(계정 B)에서 API Gateway 프라이빗 REST API를 생성합니다.
  3. 인터페이스 엔드포인트가 API를 호출할 수 있도록 허용하는 프라이빗 REST API에 대한 리소스 정책을 구성합니다.
  4. 프라이빗 REST API에 대한 메서드를 설정합니다.
  5. 프라이빗 REST API를 배포합니다.
  6. 계정 A에서 프라이빗 REST API를 호출하여 설정을 테스트합니다.

해결 방법

한 계정(계정 A)에서 Amazon VPC에 인터페이스 엔드포인트를 생성합니다.

새 인터페이스 VPC 엔드포인트 생성

계정 A의 API Gateway execute-api용 인터페이스 VPC 엔드포인트 생성 지침을 따릅니다.

중요: [정책]에서 [전체 액세스]를 선택합니다. VPC 엔드포인트 정책을 사용하여 API ID로 엔드포인트 액세스를 제한하는 것이 모범 사례입니다. API Gateway 리소스 정책을 사용하여 보안 주체별로 엔드포인트 액세스를 제한하는 것도 모범 사례입니다. 최소 권한 부여에 대한 보안 조언에 대한 자세한 내용은 IAM 사용 설명서의 최소 권한 부여를 참조하십시오.

인터페이스 엔드포인트를 생성할 때 다음 사항을 고려하십시오.

인터페이스 엔드포인트의 VPC 엔드포인트 ID 검색

[엔드포인트 생성]을 선택하고 인터페이스 엔드포인트를 생성하면 VPC 엔드포인트 ID가 나타납니다. 새 인터페이스 엔드포인트의 VPC 엔드포인트 ID를 복사합니다 (예: vpce-1a2b3c456d7e89012). 그 다음 [닫기]를 선택합니다.

참고: 프라이빗 REST API를 생성하고 구성할 때 이 ID를 사용합니다.

인터페이스 엔드포인트의 퍼블릭 DNS 이름 검색

[닫기]를 선택하면 Amazon VPC 콘솔에서 엔드포인트 페이지가 열립니다. 엔드포인트 페이지의 세부 정보 탭에 있는 DNS 이름 열에서 인터페이스 엔드포인트의 퍼블릭 DNS 이름을 찾아 복사합니다. 예: vpce-1a2b3c456d7e89012-f3ghijkl.execute-api.region.vpce.amazonaws.com.

두 번째 계정(계정 B)에 API Gateway 프라이빗 REST API를 생성합니다.

1.    계정 B에서 API Gateway 콘솔을 엽니다.

2.    [API 생성]을 선택합니다.

3.    API 유형 선택REST API에서 구축를 선택합니다.

4.    [생성] 페이지에서 [프로토콜 선택]을 REST로 둡니다.

5.    [새 API 생성]에서 [새 API]를 선택합니다.

6.    [설정]에서 다음을 수행합니다.
[API 이름]에 API 이름을 입력합니다.
(선택 사항) [설명]에 API에 대한 설명을 입력합니다.
엔드포인트 유형프라이빗으로 설정합니다.
VPC 엔드포인트 ID는 인터페이스 엔드포인트 ID를 붙여 넣습니다. 그런 다음 [추가]를 선택합니다.
참고: 인터페이스 엔드포인트를 프라이빗 REST API와 연결하면 API Gateway가 새로운 Amazon Route 53 별칭 레코드를 생성합니다. Route 53 별칭을 사용하여 프라이빗 API에 액세스할 수 있습니다.

7.    [API 생성]을 선택합니다.

자세한 내용은 Amazon API Gateway에서 프라이빗 API 생성을 참조하세요.

인터페이스 엔드포인트가 API를 호출할 수 있도록 허용하는 프라이빗 REST API에 대한 리소스 정책을 구성합니다.

1.    API Gateway 콘솔의 왼쪽 탐색 창에서 API 아래의 [리소스 정책]을 선택합니다.

2.    [리소스 정책] 페이지에서 다음 예제 리소스 정책을 텍스트 상자에 붙여 넣습니다.

참고: vpce-1a2b3c456d7e89012를 복사한 인터페이스 엔드포인트 ID로 바꿉니다.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Deny",
      "Principal": "*",
      "Action": "execute-api:Invoke",
      "Resource": "execute-api:/*/*/*",
      "Condition": {
        "StringNotEquals": {
          "aws:sourceVpce": "vpce-1a2b3c456d7e89012"
        }
      }
    },
    {
      "Effect": "Allow",
      "Principal": "*",
      "Action": "execute-api:Invoke",
      "Resource": "execute-api:/*/*/*"
    }
  ]
}

자세한 내용은 프라이빗 API에 대한 리소스 정책 설정을 참조하세요.

프라이빗 REST API에 대한 메서드를 설정합니다.

1.    API Gateway 콘솔의 왼쪽 탐색 창에서 [리소스]를 선택합니다.

2.    [리소스] 창에서 [작업]을 선택합니다. 그런 다음, [메서드 생성]을 선택합니다.

3.    /resource 노드 아래의 드롭다운 목록에서 [모두]를 선택합니다. 그런 다음, 확인 표시 아이콘을 선택합니다.

4.    / - ANY - 설정 창의 [통합 유형]은 [모의]를 선택합니다.
참고: 모의 통합은 도달하는 모든 요청에 응답합니다. 이 응답은 테스트 시 도움이 됩니다.

5.    [저장(Save)]을 선택합니다.

자세한 내용은 API Gateway에서 REST API 메서드 설정을 참조하세요.

프라이빗 REST API 배포

1.    API Gateway 콘솔의 [리소스] 창에서 [작업]을 선택하고 [API 배포]를 선택합니다.

2.    [API 배포] 대화 상자에서 다음을 수행합니다.
[배포 스테이지]에서 [새 스테이지]를 선택합니다.
[스테이지 이름]에 이름을 입력합니다. 예를 들어 dev 또는 test로 입력할 수 있습니다.
[배포]를 선택합니다.

3.    [스테이지 편집기] 창에서 프라이빗 REST API의 호출 URL이 포함된 메시지("Private DNS가 활성화된 경우 이 URL 사용:")를 찾습니다. 그런 다음 URL을 복사합니다.
참고: 프라이빗 REST API의 호출 URL을 사용하여 설정을 테스트합니다.

자세한 내용은 API Gateway 콘솔을 사용하여 프라이빗 API 배포를 참조하세요.

계정 A에서 프라이빗 REST API를 호출하여 설정을 테스트합니다.

1.    계정 A에서, 인터페이스 엔드포인트와 동일한 Amazon VPC에서 Amazon Elastic Compute Cloud(Amazon EC2) 인스턴스를 시작합니다.
중요: 설정하는 동안 인터페이스 엔드포인트와 연결한 기존 보안 그룹을 선택합니다.

2.    Amazon EC2 인스턴스에 연결합니다.

참고: Amazon EC2 인스턴스를 사용하면 AWS 계정에 요금이 발생할 수 있습니다. 이 설정을 테스트할 목적으로만 인스턴스를 생성하는 경우, 반복 요금이 발생하지 않도록 작업을 마쳤을 때 인스턴스를 종료합니다.

3.    Amazon EC2 인스턴스의 명령줄에서 다음 curl 명령 중 하나를 사용하여 계정 B의 프라이빗 REST API를 호출합니다.
참고: 자세한 내용은 엔드포인트별 퍼블릭 DNS 호스트 이름을 사용하여 프라이빗 API 호출을 참조하세요. curl에 대한 자세한 내용은 curl 프로젝트 웹 사이트를 참조하세요.

프라이빗 DNS 이름을 사용하여 API 호출하기

curl -i https://a1bc234d5e.execute-api.region.amazonaws.com/stage-name

참고: https://a1bc234d5e.execute-api.region.amazonaws.com/stage-name을 API Gateway 콘솔에서 복사한 프라이빗 API의 호출 URL로 바꿉니다. 이 명령은 인터페이스 엔드포인트에 대해 프라이빗 DNS를 활성화한 경우에만 작동합니다. 자세한 내용은 프라이빗 DNS 이름을 사용하여 프라이빗 API 호출을 참조하십시오.

Route 53 별칭을 사용하여 API 호출하기

curl -i https://a1bc234d5e-vpce-1a2b3c456d7e89012.execute-api.region.amazonaws.com/stage-name

참고: a1bc234d5e를 API의 ID로 바꿉니다.
vpce-1a2b3c456d7e89012를 인터페이스 엔드포인트 ID로 바꿉니다.
region을 해당하는 리전 코드로 바꿉니다. (예: us-east-1)
stage-name을 프라이빗 API를 배포한 스테이지의 이름으로 바꿉니다. 자세한 내용은 Route 53 별칭을 사용하여 프라이빗 API 액세스를 참조하십시오.

호스트 헤더가 있는 퍼블릭 DNS 이름을 사용하여 API 호출하기

curl -i https://vpce-1a2b3c456d7e89012-f3ghijkl.execute-api.region.vpce.amazonaws.com/stage-name -H "Host: a1bc234d5e.execute-api.region.amazonaws.com"

참고: vpce-1a2b3c456d7e89012-f3ghijkl.execute-api.region.vpce.amazonaws.com을 Amazon VPC 콘솔에서 기록해 둔 퍼블릭 DNS 이름으로 바꿉니다.
stage-name을 프라이빗 API를 배포한 스테이지의 이름으로 바꿉니다.
a1bc234d5e.execute-api.region.amazonaws.com을 API Gateway 콘솔의 프라이빗 API의 호출 URL로 바꿉니다.

x-apigw-api-id 헤더가 있는 퍼블릭 DNS 이름을 사용해 API 호출하기

curl -i https://vpce-1a2b3c456d7e89012-f3ghijkl.execute-api.region.vpce.amazonaws.com/stage-name -H "x-apigw-api-id:a1bc234d5e"

참고: vpce-1a2b3c456d7e89012-f3ghijkl.execute-api.region.vpce.amazonaws.com을 Amazon VPC 콘솔에서 기록해 둔 퍼블릭 DNS 이름으로 바꿉니다.
stage-name을 프라이빗 API를 배포한 스테이지의 이름으로 바꿉니다.
a1bc234d5e를 API의 ID로 바꿉니다.

4.    명령 출력을 검토합니다. API Gateway는 연결이 성공하면 200 OK 응답을 반환합니다.