Amazon API Gateway
개발자 안내서

API 키를 이용한 사용량 계획의 생성 및 사용

API를 생성, 테스트, 배포한 후 API Gateway 사용량 계획을 사용하여 API를 고객을 위한 제품으로 만들 수 있습니다. 사용량 계획과 API 키를 구성하여 고객이 합의된 요청 속도로 선택된 API에 액세스하고, 고객의 비즈니스 요구 사항과 예산 한도에 맞는 할당량에 액세스하도록 할 수 있습니다. 원하는 경우 API에 대한 기본 메서드 수준 조절 한도를 설정하거나 개별 API 메서드에 대해 조절 한도를 설정할 수 있습니다.

사용량 계획과 API 키란 무엇인가?

사용량 계획은 배포된 하나 이상의 API 단계에 누가 액세스할 수 있는지 지정하고 — 얼마나 많이, 또 얼마나 빨리 액세스할 수 있는지도 지정합니다. 이 계획은 API 키를 사용하여 API 클라이언트를 식별하고 각 키에 연결된 API 단계에 대한 액세스를 측정합니다. 또한 개별 클라이언트 API 키에 적용되는 조절 한도 및 할당량 제한을 구성할 수 있습니다.

API 키는 앱 개발자 고객에게 API 액세스 권한을 부여하기 위해 배포하는 영숫자 문자열 값입니다. API 키와 사용량 계획 또는 Lambda 권한 부여자를 함께 사용하여 API 액세스를 제어할 수 있습니다. API Gateway가 사용자 대신 API 키를 생성하거나, 사용자가 CSV 파일에서 API 키를 가져올 수 있습니다. API Gateway에서 API 키를 생성하거나 외부 소스에서 API Gateway로 API 키를 가져올 수 있습니다. 자세한 내용은 API Gateway 콘솔을 사용한 API 키 설정 단원을 참조하십시오.

API 키는 이름과 값을 갖습니다. ("API 키"와 "API 키 값"은 종종 서로 바꿔 사용됩니다.) 값은 30-128자의 영숫자 문자열입니다(예: apikey1234abcdefghij0123456789).

중요

API 키 값은 고유해야 합니다. 두 개의 API 키를 이름은 다르고 값은 동일하게 생성하려고 하면 API Gateway가 이 두 키를 동일한 API 키로 인식합니다.

API 키는 하나 이상의 사용량 계획과 연결할 수 있습니다. 사용량 계획은 하나 이상의 단계와 연결할 수 있습니다. 그러나 지정된 API 키는 API의 각 단계에 대하여 단 하나의 사용량 계획에만 연결할 수 있습니다.

조절 한도는 사용량 계획에 추가하는 각각의 API 키에 적용되는 요청 속도 한계입니다. API에 대한 기본 메서드 수준 조절 한도를 설정하거나 개별 API 메서드에 대해 조절 한도를 설정할 수도 있습니다.

할당량 한도는 지정된 시간 안에 지정된 API 키를 제출할 수 있는 최대 요청 수입니다. 사용량 계획 구성에 따라 API 키 권한 부여를 요구하도록 개별 API 메서드를 구성할 수 있습니다. 그리고 get-usage CLI 명령과 usage:get REST API 메서드를 사용하여 API의 고객이 사용한 할당량을 확인할 수 있습니다.

참고

조절 및 할당량 한도는 한 가지 사용량 계획의 모든 API 단계에서 집계된 요청의 개별 API 키에 적용됩니다.

API 키 및 사용량 계획의 위한 모범 사례

다음은 API 키 및 사용량 계획을 사용할 때 따를 수 있는 모범 사례입니다.

  • API 키를 API에 대한 유일한 인증 및 권한 부여 수단으로 사용하지 마십시오. 무엇보다도, 사용량 계획에 API가 여러 개 있는 경우, 하나의 API에 대해 유효한 API 키를 가진 사용자는 사용량 계획의 모든 API에 액세스할 수 있기 때문입니다. IAM 역할, Lambda 권한 부여자 또는 Amazon Cognito 사용자 풀을 사용하십시오.

  • 개발자 포털을 사용하여 API를 게시할 경우 다른 API를 고객에게 공개하지 않았더라도 해당 사용량 계획의 모든 API가 구독 가능해집니다.