使用 API 密鑰與 Grafana HTTP API 進行身份驗證 - Amazon Managed Grafana
建立工作區 API 金鑰 (主控台)建立工作區 API 金鑰 (AWS CLI)

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

使用 API 密鑰與 Grafana HTTP API 進行身份驗證

訪問 Grafana API 的一種方法是使用 API 密鑰，也稱為 API 令牌。若要建立 API 金鑰，請使用下列其中一個程序。API 金鑰在您建立時指定的有限時間內有效，最多 30 天。

注意

在版本 9 或更新版本中，首選使用服務帳戶而不是 API 密鑰。服務帳戶正在取代 API 金鑰，作為驗證與 Grafana API 互動之應用程式的主要方式。Grafana 實驗室宣布將在 future 的發行版本中刪除 API 密鑰。

建立 API 金鑰時，您可以指定金鑰的角色。角色決定金鑰使用者擁有的系統管理權力層級。

下表顯示授與「管理員」、「編輯者」和「檢視者」角色的權限。第一個表格顯示一般組織權限。在此表格中，「完整」表示能夠檢視、編輯、新增權限及刪除權限。「瀏覽」欄會顯示角色是否可以使用「瀏覽」檢視。「其他權限」欄會顯示角色是否具有管理使用者、小組、外掛程式和組織設定的權限。

角色 儀表板 播放列 資料夾 探索 資料來源 其他權限

Viewer (檢視者)

 檢視 檢視 否 否 否 否

Editor (編輯器)

 完整 完整 完整 是 否 否

管理員

 完整 完整 完整 是 完整 完整

下表顯示您可以設定的其他儀表板和資料夾層級權限。這些角色與「管理員」、「編輯者」和「檢視者」角色不同。

角色 儀表板 資料夾 變更權限

檢視

 檢視 檢視 否

Edit (編輯)

 建立、編輯 檢視 否

管理員

 建立、編輯、刪除 建立、編輯、刪除 是
注意

如果存在具有更多權限的更一般規則，則具有較低權限層級的較為範圍的權限不會生效。例如，如果您將組織編輯者角色授予使用者，然後僅為該使用者指派儀表板的 [檢視] 權限，則限制性較高的 [檢視] 權限就沒有作用，因為使用者因為其編輯者角色具有完整的 [編輯] 存取權限。

建立 Grafana API 金鑰，以便在工作區 (主控台) 中與 Grafana API 搭配使用

注意

在與 Grafana 版本 10 及以上版本相容的 Amazon 受管 Grafana 工作區中，已移除在工作區中建立 API 金鑰的功能。如果您的工作區是 Grafana 第 10 版的工作區，您只能透過 AWS CLI 或 API 建立 API 金鑰。

Grafana 實驗室已宣布移除 API 金鑰，用於 future 的發行版本。建議您改用服務帳戶。

若要在工作區主控台中建立與 Grafana API 搭配使用的 Grafana API 金鑰

  1. 打開 Amazon 託管 Grafana 控制台，網址為 https://console.aws.amazon.com/grafana/。

  2. 選擇頁面左上角的功能表圖示，然後選擇所有工作區。

  3. 選擇 Amazon 受管的 Grafana 工作區的名稱。

  4. 在工作區詳細資訊頁面中，選擇顯示在 Grafana 工作區 URL 下方的 URL。

  5. 在 Grafana 主控台側邊選單中，暫停設定 (齒輪) 圖示，然後選擇 API 金鑰。

  6. 選擇 [新增 API 金鑰]。

  7. 輸入金鑰的唯一名稱。

  8. 對於角色，選取要授與金鑰的存取層級。選取 [管理員]，允許擁有此金鑰的使用者以最廣泛、最強大的管理層級使用 API。選取編輯器或檢視器，將金鑰的使用者限制在這些電源等級。如需詳細資訊，請參閱先前的表格。

  9. 對於「存留時間」，指定您希望金鑰有效的時間長度。最長為 30 天（一個月）。您輸入一個數字和一個字母。有效字母為 s 表示秒，m 表示分鐘，h 表示小時，d 表示天，w 表示週，M 表示月份。例如，12 小時是 12 小時，1 米是 1 個月（30 天）。

    我們強烈建議您將金鑰的存放時間設定為較短的時間，例如幾個小時或更短的時間。與擁有長時間有效的 API 密鑰相比，這會產生更小的風險。

  10. 選擇新增。

  11. (選擇性) 您可以使用地形表單建立 API 金鑰 API 來自動建立 API 金鑰。如需使用 Terraform 自動建立 API 金鑰的詳細資訊，請參閱使用地形建立 Grafana API 金鑰。

使用建立 Amazon 受管的 Grafana 工作區 API 金鑰 AWS CLI

若要使用建立 Amazon 受管的 Grafana 工作區 API 金鑰 AWS CLI

在下面的例子中，用您自己的信息替換密鑰名，key_role，第二個 _ to_live 和工作空間 ID。若要瞭解金鑰名稱、金鑰角色和 seconds-to-live的格式，請參閱 API 指南https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html中的〈〉。

aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-live seconds_to_live --workspace-id "workspace_id"

以下是 CLI 回應範例：

create-workspace-api-key 輸出示例

您可以執行下列命令來尋找工作區的 Workspace _id：

aws grafana list-workspaces