使用 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 Labs宣布，API密钥将在未来的版本中删除。

创建 API 密钥时，需要为密钥指定一个角色。该角色决定了密钥用户拥有的管理权限级别。

下表显示了授予管理员、编辑者和查看者角色的权限。第一张表显示了一般的组织权限。在此表中，“完整” 表示能够查看、编辑、添加权限和删除权限。“浏览” 列显示角色是否可以使用 “浏览” 视图。其他权限列显示该角色是否具有管理用户、团队、插件和组织设置的权限。

角色 控制面板 播放列表 文件夹 探索 数据来源 其他权限

查看者

 查看 查看 否 否 否 否

Editor (编辑器)

 完整 完整 完整 是 否 否

Admin

 完整 完整 完整 是 完整 完整

下表显示了您可以设置的其他仪表板和文件夹级权限。这些角色不同于 “管理员”、“编辑” 和 “查看者” 角色。

角色 控制面板 文件夹 更改权限

视图

 查看 查看 否

编辑

 创建、编辑 查看 否

Admin

 创建、编辑、删除 创建、编辑、删除 是
注意

如果存在具有更多权限的更通用的规则，则范围更广、权限级别较低的权限不会生效。例如，如果您为用户授予组织编辑者角色，然后仅向该用户分配仪表板的 “查看” 权限，则限制性更强的 “查看” 权限将不起作用，因为该用户因其编辑角色而具有完全的编辑访问权限。

在工作区（控制台）中创建 Grafana API 密钥以与 Grafana API 配合使用

注意

在与 Grafana 版本 10 及更高版本兼容的亚马逊托管 Grafana 工作空间中，删除了在工作空间中创建 API 密钥的功能。如果您的工作空间是 Grafana 版本 10 的工作空间，则只能通过 AWS CLI 或 API 创建 API 密钥。

Grafana Labs已宣布在未来的版本中移除API密钥。建议您改用服务帐号。

在工作空间控制台中创建 Grafana API 密钥以与 Grafana API 配合使用

  1. 打开 Amazon Managed Grafana 控制台，网址为 https://console.aws.amazon.com/grafana/。

  2. 在页面左上角，选择菜单图标，然后选择所有工作区。

  3. 选择亚马逊托管 Grafana 工作空间的名称。

  4. 在工作空间详情页面中，选择 Grafana 工作空间 URL 下显示的网址。

  5. 在 Grafana 控制台的侧面菜单中，将鼠标悬停在配置（齿轮）图标上，然后选择 API 密钥。

  6. 选择 “新建 API 密钥”。

  7. 输入密钥的唯一名称。

  8. 在 “角色” 中，选择要授予密钥的访问级别。选择 “管理员”，允许拥有此密钥的用户在最广泛、最强大的管理级别上使用 API。选择 “编辑器” 或 “查看器”，将密钥的用户限制在这些级别以内。有关更多信息，请参阅前面的表。

  9. 在 T ime to Live 中，指定您希望密钥的有效期限。最长为 30 天（一个月）。您输入一个数字和一个字母。有效的字母是 s 代表秒，m 代表分钟，h 代表小时，d 代表天，w 代表周，M 代表月。例如，12 小时为 12 小时，1 小时为 1 个月（30 天）。

    我们强烈建议您将密钥的存活时间设置为更短的时间，例如几个小时或更短。与拥有长时间有效的 API 密钥相比，这带来的风险要小得多。

  10. 选择添加。

  11. （可选）您可以使用 Terraform 使用创建 API 密钥 API 自动创建 API 密钥。有关使用 Terraform 自动创建 API 密钥的更多信息，请参阅使用 Terraform 创建 Grafana API 密钥。

使用创建亚马逊托管 Grafana 工作空间 API 密钥 AWS CLI

使用创建亚马逊托管 Grafana 工作空间 API 密钥 AWS CLI

在以下示例中，用您自己的信息替换 key_name、key_role、sec onds_to_liv e 和 workspace_id。要了解密钥名称、密钥角色和的格式 seconds-to-live，请参阅 https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html API 指南。

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