使用 API Gateway 主控台設定 API 金鑰 - Amazon API Gateway
方法中需要 API 金鑰建立 API 金鑰匯入 API 金鑰

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

使用 API Gateway 主控台設定 API 金鑰

若要設定 API 金鑰，請執行下列步驟：

  • 設定 API 方法以要求 API 金鑰。

  • 為區域中的 API 建立或匯入 API 金鑰。

在設定 API 金鑰之前，您必須已建立 API 並將它部署至階段。在您建立 API 金鑰值之後便無法變更。

如需如何使用 API Gateway 主控台建立和部署 API 的說明，請參閱在 APIs Gateway 中開發 REST API 和在 API Gateway 中部署 REST API。

建立 API 金鑰後，您必須為該金鑰與用量計畫建立關聯。如需詳細資訊，請參閱使用 API Gateway 主控台建立、設定和測試用量計劃。

注意

如需考量最佳實務，請參閱 API 金鑰和用量計劃的最佳實務。

方法中需要 API 金鑰

下列程序說明如何設定 API 方法要求 API 金鑰。

設定 API 方法要求 API 金鑰

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

  2. 選擇 REST API。

  3. 在 API Gateway 主導覽窗格中，選擇 Resources (資源)。

  4. 在 Resources (資源) 下，建立新的方法或選擇現有的方法。

  5. 在方法請求索引標籤的方法請求設定下，選擇編輯。

    將 API 金鑰新增至方法

  6. 選取需要 API 金鑰。

  7. 選擇 Save (儲存)。

  8. 部署或重新部署 API 以使要求生效。

如果需要 API 金鑰選項設為 false，而且您不執行之前的各項步驟，則方法不會使用任何與 API 階段相關聯的 API 金鑰。

建立 API 金鑰

如果您已建立或匯入 API 金鑰供用量計劃使用，您可以略過此操作和下一個程序。

建立 API 金鑰

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

  2. 選擇 REST API。

  3. 在 API Gateway 主導覽窗格中，選擇 API 金鑰。

  4. 選擇建立 API 金鑰。

    建立用量計劃的 API 金鑰

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

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

  7. 針對 API 金鑰，選擇自動產生讓 API Gateway 產生金鑰值，或選擇自訂建立您自己的金鑰值。

  8. 選擇 Save (儲存)。

匯入 API 金鑰

下列程序說明如何匯入 API 金鑰供用量計劃使用。

匯入 API 金鑰

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

  2. 選擇 REST API。

  3. 在主導覽窗格中，選擇 API 金鑰。

  4. 選擇動作下拉式選單，然後選擇匯入 API 金鑰。

  5. 若要載入逗號分隔的金鑰檔案，請選擇選取檔案。您也可以在文字編輯器中輸入金鑰。如需檔案格式的資訊，請參閱 API Gateway API 金鑰檔案格式。

  6. 選擇發出警告時失敗，在發生錯誤時停止匯入，或選擇忽略警告，在出現警告時繼續匯入有效的金鑰項目。

  7. 選擇匯入以匯入您的 API 金鑰。