API Gateway의 REST API 사용량 계획 테스트

예를 들어 자습서: 예제를 가져와 REST API 생성에서 생성한 PetStore API를 사용해 보겠습니다. 이 API는 API 키 Hiorr45VR...c4GJc를 사용하도록 구성되었다고 가정합니다. 다음 단계에서는 사용량 단계를 테스트하는 방법에 대해 설명합니다.

사용량 계획을 테스트하려면

• 사용량 계획에 API의 GET 쿼리 파라미터(예: /pets)가 포함된 Pets 리소스(?type=...&page=...)에서 xbvxlpijch 요청을 합니다.

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  참고

  API Gateway의 execute-api 구성 요소에 이 요청을 제출하고 필수 Hiorr45VR...c4GJc 헤더에 필수 API 키(예: x-api-key)를 제공해야 합니다.

  응답이 성공하면 백엔드에서 200 OK 상태 코드와 요청한 결과가 포함된 페이로드가 반환됩니다. x-api-key 헤더 설정을 잊었거나 잘못된 키로 설정한 경우, 403 Forbidden 응답을 받게 됩니다. 하지만 API 키를 요구하도록 메서드를 구성하지 않은 경우, 200 OK 헤더를 올바르게 설정하든 그렇지 않든 x-api-key 응답을 받을 가능성이 높으며, 사용량 계획의 조절 및 할당량 제한은 우회됩니다.

  경우에 따라 API Gateway가 요청에 대해 사용량 계획 조절 제한 또는 할당량을 적용할 수 없는 내부 오류가 발생할 경우, API Gateway는 조절 제한 또는 할당량을 사용량 계획에 지정된 대로 적용하지 않고 요청을 제공합니다. 하지만 CloudWatch에 Usage Plan check failed due to an internal error 오류 메시지를 기록합니다. 가끔 발생하는 이러한 오류는 무시해도 좋습니다.