API 金鑰

API 金鑰與使用者驗證

如果你想使用外部應用程式存取你的 Rancher 叢集、專案或其他物件，你可以使用 Rancher API 來完成。然而，在你的應用程式可以存取 API 之前，你必須為應用程式提供用於向 Rancher 驗證的金鑰。你可以使用 Rancher UI 來取得金鑰。

使用 Rancher CLI 也需要 API 金鑰。

API 金鑰由四個元件組成：

• 端點（Endpoint）：這是其他應用程式用來向 Rancher API 發送請求的 IP 位址和路徑。
• 存取金鑰（Access Key）：令牌的使用者名稱。
• 秘密金鑰（Secret Key）：令牌的密碼。對於提示你輸入兩個不同字串進行 API 驗證的應用程式，你通常會一起輸入這兩個金鑰。
• 持有者令牌（Bearer Token）：令牌使用者名稱和密碼串接在一起。對於提示你輸入一個驗證字串的應用程式，請使用此字串。

備註

使用者可以選擇啟用令牌雜湊。

建立 API 金鑰

1. 從右上角選擇使用者頭像 > 帳戶與 API 金鑰。

2. 點擊建立 API 金鑰。

3. 可選：為 API 金鑰輸入描述，並選擇到期時間或範圍。我們建議設定到期日期。

   API 金鑰在到期後將不再有效。較短的到期時間更加安全。

   到期時間受 v3/settings/auth-token-max-ttl-minutes 限制。如果超過最大 TTL，API 金鑰將以最大 TTL 作為到期時間建立。

   範圍會限制 API 金鑰，使其僅對指定叢集的 Kubernetes API 有效。如果叢集配置了授權叢集端點，你可以直接對叢集的 API 使用範圍令牌，而無需透過 Rancher 伺服器代理。詳情請參閱授權叢集端點。

4. 點擊建立。

   步驟結果：你的 API 金鑰已建立。你的 API 端點、存取金鑰、秘密金鑰和持有者令牌將會顯示。

   使用持有者令牌向 Rancher CLI 進行驗證。

5. 將顯示的資訊複製到安全的位置。此資訊只會顯示一次，因此如果你遺失了金鑰，你將必須建立新的金鑰。

下一步

• 將你的 API 金鑰資訊輸入到向 Rancher API 發送請求的應用程式中。
• 在 Rancher UI 中選擇物件的在 API 中檢視，以了解更多關於 Rancher 端點和參數的資訊。
• API 金鑰用於 API 呼叫和 Rancher CLI。

刪除 API 金鑰

如果你需要撤銷 API 金鑰，請刪除它。你應該刪除以下 API 金鑰：

• 可能已被洩露的金鑰。
• 已過期的金鑰。

要刪除 API 金鑰，請選擇過時的金鑰並點擊刪除。