API Gateway で REST API の使用プランを維持する - Amazon API Gateway

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 所有者または管理者は残りのクォータを 3 日目に 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 を呼び出して使用量プランを維持します。