API Gateway で REST API の使用量プランをテストする - Amazon API Gateway

API Gateway で REST API の使用量プランをテストする

例として、チュートリアル: サンプルをインポートして REST API を作成する で作成される PetStore API を使用します。API は Hiorr45VR...c4GJc の API キーを使用するように設定されると仮定します。以下の手順では、使用プランをテストする方法について説明します。

使用プランをテストするには

  • 使用量プランの 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 のエラーメッセージが記録されます。ときどき起こるこのようなエラーは無視してかまいません。