API密钥

API密钥是一个随机生成的字符串，外部系统使用它与Grafana HTTP API交互。

当你创建一个API键时，你指定一个角色它决定了与API键相关联的权限。角色权限控制API键可以在Grafana资源上执行哪些操作。

注意:如果使用Grafana v8.5或更新版本，请使用服务帐户而不是API密钥。更多信息，请参考Grafana服务帐户。

创建API密钥

当你想和用户一起管理计算工作负载时，创建一个API密钥。

本主题向您展示如何使用Grafana UI创建API密钥。你也可以使用Grafana HTTP API创建一个API密钥。关于通过API创建API密钥的更多信息，请参考通过API创建API密钥。

在你开始之前:

• 确保你拥有创建和编辑API键的权限。关于权限的更多信息，请参考角色和权限。

创建API键:

1. 登录到Grafana，将鼠标悬停在上面配置(齿轮图标)，点击API密钥。
2. 点击新的API密钥。
3. 为键输入唯一的名称。
4. 在角色字段中，选择要分配给密钥的下列访问级别之一。
   • 管理:使用户能够在最广泛、最强大的管理级别上使用api。
   • 编辑器或查看器将密钥的用户限制在这些级别的权力。
5. 在生存时间字段，指定您希望密钥有效的时间。
   • 最长时间为30天(一个月)。输入一个数字和一个字母。包括有效的字母年代秒,米几分钟,h几个小时,d好几天,w好几个星期,米月。例如,12小时是12小时和1米是1个月(30天)。
   • 如果你不确定一个API密钥应该有效多长时间，我们建议你选择一个较短的持续时间，比如几个小时。这种方法限制了拥有长时间有效的API密钥的风险。
6. 点击添加。

将API key迁移到Grafana服务账户

可以将一个或所有API键迁移到Grafana服务帐户。当您将API密钥迁移到服务帐户时，将使用服务帐户令牌创建服务帐户。API密钥将继续工作，你可以在Grafana服务账户令牌细节。有关服务账户的更多信息，请参阅Grafana服务账户的好处。

可以选择迁移单个API密钥，也可以选择迁移所有API密钥。注意，当你迁移所有API密钥时，你就不能再创建新的API密钥了，只能使用服务帐户来代替。

在你开始之前

• 确保您拥有创建Grafana服务帐户的权限。关于权限的更多信息，请参考角色和权限。

将所有API密钥迁移到服务帐户:

1. 登录到Grafana，将鼠标悬停在上面配置(齿轮图标)，点击API密钥。
2. 在页面顶部，找到写着从API密钥切换到服务帐户
3. 点击现在迁移到服务帐户。
4. 将出现一个确认窗口，要求确认迁移。点击是的,现在迁移如果您愿意继续。
5. 一旦迁移成功，你可以选择永远隐藏API键页。点击永远隐藏API键页如果你想这么做的话。

将单个API密钥迁移到服务帐户:

1. 登录到Grafana，将鼠标悬停在上面配置(齿轮图标)，点击API密钥。
2. 找到你想要迁移的API Key。
3. 点击迁移至服务账户。

将服务账户令牌还原为API密钥

注意:这是不必要的操作，只应在紧急情况下使用。

可以将服务账户令牌转换回API密钥。您可以使用将服务帐户令牌还原为API关键HTTP API的。

revert将执行以下操作:

1. 将给定的服务帐户令牌转换回API密钥
2. 删除与给定密钥关联的服务帐户。确保没有其他与服务账户关联的令牌，否则将全部删除。