API Gateway에서 REST API에 대한 사용량 계획 유지 관리

사용량 계획을 유지 관리하려면 지정된 기간 동안 사용한 할당량과 남은 할당량을 모니터링하고, 필요하면 남은 할당량을 지정된 크기만큼 확장해야 합니다. 다음 절차에서는 할당량을 모니터링하는 방법을 설명합니다.

AWS Management Console

사용한 할당량과 남은 할당량을 모니터링하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. API Gateway 기본 탐색 창에서 사용량 계획을 선택합니다.

3. 사용량 계획을 선택합니다.

4. 연결된 API 키 탭을 선택하면 각 키에 대해 해당 기간 동안 남아 있는 요청 수를 확인할 수 있습니다.

5. (선택 사항) 사용량 데이터 내보내기를 선택한 다음 시작 날짜 및 종료 날짜를 선택합니다. 그런 다음 내보내는 데이터 형식으로 JSON 또는 CSV를 선택하고 내보내기를 선택합니다.

   다음은 내보낸 파일의 예입니다.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   이 예에서 사용량 데이터는 API 키(px1KW6...qBazOJH)로 식별되듯이 2016년 8월 1일부터 2016년 8월 3일 사이의 API 클라이언트의 일일 사용량 데이터를 보여 줍니다. 일일 사용량 데이터는 사용한 할당량과 남은 할당량을 보여줍니다. 이 예에서 구독자는 할당량을 아직 사용하지 않았고, API 소유자 또는 관리자가 셋째 날에 남은 할당량을 5000에서 10으로 줄였습니다.

다음 절차에서는 할당량을 수정하는 방법을 설명합니다.

남은 할당량을 확장하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. API Gateway 기본 탐색 창에서 사용량 계획을 선택합니다.

3. 사용량 계획을 선택합니다.

4. 연결된 API 키 탭을 선택하면 각 키에 대해 해당 기간 동안 남아 있는 요청 수를 확인할 수 있습니다.

5. API 키를 선택한 다음 사용량 확장 부여를 선택합니다.

6. 남은 요청 할당량에 숫자를 입력합니다. 사용량 계획 기간 동안 남은 요청을 늘리거나 줄일 수 있습니다.

7. 업데이트 할당량을 선택합니다.

AWS CLI

다음 update-usage-plan 예제에서는 사용량 계획에서 메서드 수준 스로틀링 설정을 추가, 제거 또는 수정합니다.

참고

us-east-1을 API에 해당하는 리전 값으로 변경해야 합니다.

개별 리소스와 메서드 조절의 속도 제한을 추가하거나 바꾸는 방법:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

개별 리소스와 메서드 조절의 버스트 제한을 추가하거나 바꾸는 방법:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

개별 리소스와 메서드에 대한 메서드 수준 조절 설정을 제거하는 방법:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

API에 대한 모든 메서드 수준 조절 설정을 제거하는 방법:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

다음은 Pet Store 샘플 API를 사용하는 예입니다.

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

usageplan:update를 직접적으로 호출하여 사용량 계획을 유지 관리합니다.