使用 API Gateway 主控台建立、設定和測試用量計劃 - Amazon API Gateway
遷移您的 API 到預設用量計劃 (如需要)建立用量計劃測試用量計劃維護計劃用量

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 API Gateway 主控台建立、設定和測試用量計劃

建立用量計劃之前，請確保您已設定所需的 API 金鑰。如需詳細資訊，請參閱使用 API Gateway 主控台設定 API 金鑰。

本節說明如何使用 API Gateway 主控台建立和使用用量計劃。

遷移您的 API 到預設用量計劃 (如需要)

如果您在 2016 年 8 月 11 日推出用量計劃功能「之後」開始使用 API Gateway，就可以自動在所有支援的區域中啟用用量計劃。

如果您是在該日期之前開始使用 API Gateway，則可能需要遷移到預設用量計劃。在所選區域第一次使用用量計劃之前，系統會提示您 Enable Usage Plans (啟用用量計劃) 選項。當您啟用此選項時，您已為與現有 API 金鑰相關聯的每個唯一 API 階段，建立預設的用量計劃。在預設的用量計劃中，一開始並無設定調節和配額限制，而 API 金鑰和 API 階段之間的關聯會複製到用量計劃。API 的行為和以前一樣。不過，您必須使用 UsagePlan apiStages 屬性建立指定 API 階段值 (apiId 和 stage) 與內含 API 金鑰 (透過 UsagePlanKey) 的關聯，而非使用 ApiKey stageKeys 屬性。

若要查看您是否已遷移到預設用量計劃，請使用 get-account CLI 命令。在命令輸出之中，當用量計劃已啟用，features 清單就會包含 "UsagePlans" 項目。

您也可以使用 APIs 遷移至預設用量計劃 AWS CLI ，如下所示：

使用 遷移至預設用量計劃 AWS CLI

  1. 呼叫 CLI 命令：update-account。

  2. 針對 cli-input-json 參數，請使用下列 JSON：

    [
    {
        "op": "add",
        "path": "/features",
        "value": "UsagePlans"
    }
]

建立用量計劃

下列程序說明如何建立用量計劃。

建立用量計劃

  1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

  2. 在 API Gateway 主導覽窗格中，選擇用量計劃，然後選擇建立用量計劃。

    API 用量計劃實體

  3. 針對名稱，輸入名稱。

  4. 在描述，請輸入描述。

  5. 根據預設，用量計劃會啟用限流。輸入用量計劃的費率和暴增。選擇限流以關閉限流。

  6. 根據預設，用量計劃會針對一段時間啟用一個配額。針對請求，輸入使用者在您的用量計劃期間內可提出的請求總數。選擇配額以關閉配額。

  7. 選擇建立用量計劃。

若要將階段新增至用量計劃

  1. 選取您的用量計劃。

  2. 在關聯的階段索引標籤下，選擇新增階段。

    將 API 階段新增至用量計畫表。

  3. 針對 API，選取 API。

  4. 針對階段，選取階段。

  5. (選用) 若要開啟方法層級限流，請執行下列操作：

    1. 選擇方法層級限流，然後選擇新增方法。

    2. 針對資源，從 API 中選取資源。

    3. 針對方法，從 API 中選取方法。

    4. 輸入用量計劃的費率和暴增。

  6. 選擇新增至用量計劃。

若要將金鑰新增至用量計劃

  1. 在關聯的 API 金鑰索引標籤下，選擇新增 API 金鑰。

    API 用量計劃實體

    1. 若要將現有金鑰與用量計劃建立關聯，請選取新增現有金鑰，然後從下拉式選單選取您現有的金鑰。

    2. 若要建立新的 API 金鑰，請選取建立並新增新金鑰，然後建立新金鑰。如需如何建立新金鑰的詳細資訊，請參閱 建立 API 金鑰。

  3. 選擇新增 API 金鑰。

測試用量計劃

若要測試用量計劃，您可以使用 AWS SDK AWS CLI或 REST API 用戶端，例如 Postman。如需使用 Postman 測試用量計劃的範例，請參閱測試用量計劃。

維護計劃用量

維護用量計劃涉及監控指定時段內已使用和剩餘的配額，以及如有需要，依指定的量擴充剩餘配額。下列程序說明如何監控配額。

監控已使用及剩餘的配額

  1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

  2. 在 API Gateway 主導覽窗格中，選擇用量計劃。

  3. 選取用量計劃。

  4. 選擇關聯的 API 金鑰索引標籤，以查看每個金鑰在期間內剩餘的請求數。

  5. (選用) 選擇匯出用量資料，然後選擇從日期和到日期。接著選擇 JSON 或 CSV 作為匯出的資料格式，然後選擇匯出。

    以下範例顯示匯出的檔案。

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

    範例中的用量資料顯示某 API 用戶端自 2016 年 8 月 1 日到 2016 年 8 月 3 日的每日用量資料，依 API 金鑰 (px1KW6...qBazOJH) 識別。每個每日用量資料都會顯示已使用和剩餘的配額。在這個範例中，訂閱者並未用完任何分配的配額，而 API 擁有者或管理員已在第三天將剩餘的配額從 5000 降至 10。

下列程序說明如何修改配額。

擴充剩餘的配額

  1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

  2. 在 API Gateway 主導覽窗格中，選擇用量計劃。

  3. 選取用量計劃。

  4. 選擇關聯的 API 金鑰索引標籤，以查看每個金鑰在期間內剩餘的請求數。

  5. 選取 API 金鑰，然後選擇授予用量延伸。

  6. 輸入剩餘的請求配額的數量。您可以針對您的用量計劃期間增加剩餘的請求數，也可以減少剩餘的請求數。

  7. 選擇更新配額。