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

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

使用API閘道主控台設定API金鑰

若要設定API金鑰，請執行下列動作：

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

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

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

如需如何使用 API API Gateway 主控台建立和部署 的指示，請RESTAPIs在API閘道中部署分別參閱 在 API Gateway RESTAPIs中開發和 。

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

注意

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

方法需要API金鑰

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

設定API方法以要求API金鑰

  1. 在 https://console.aws.amazon.com/apigateway 登入API閘道主控台。

  2. 選擇 REST API。

  3. 在API閘道主導覽窗格中，選擇資源 。

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

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

    將API金鑰新增至方法

  6. 選取API所需的金鑰 。

  7. 選擇 Save (儲存)。

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

如果API所需的金鑰選項設定為 false，而您未執行先前的步驟，則與該API階段相關聯的任何API金鑰都不會用於 方法。

建立API金鑰

如果您已建立或匯入API金鑰以搭配使用計畫使用，您可以略過此程序和下一個程序。

建立 API 金鑰

  1. 在 https://console.aws.amazon.com/apigateway 登入API閘道主控台。

  2. 選擇 REST API。

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

  4. 選擇建立API金鑰 。

    建立用量計畫的API金鑰

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

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

  7. 對於API金鑰 ，選擇自動產生讓API閘道產生金鑰值，或選擇自訂以建立您自己的金鑰值。

  8. 選擇 Save (儲存)。

匯入API金鑰

下列程序說明如何匯入要與用量計劃搭配使用的API金鑰。

若要匯入API金鑰

  1. 在 https://console.aws.amazon.com/apigateway 登入API閘道主控台。

  2. 選擇 REST API。

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

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

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

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

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