Enterprise 许可证 API
授权功能仅在 Grafana Enterprise 中可用。了解更多关于 Grafana Enterprise 的信息。
注意
您无法使用服务账号令牌对授权 HTTP API 进行身份验证。服务账号仅限于特定组织及其组织角色。它们无法获得 Grafana 服务器管理员权限。
要使用这些 API 端点，您必须使用 Basic authentication，并且 Grafana 用户必须具有 Grafana 服务器管理员权限。
默认配置的
admin用户拥有使用这些 API 端点的权限。
如果您正在运行 Grafana Enterprise，某些端点需要您拥有特定权限。请参阅 基于角色的访问控制权限 以获取更多信息。
检查许可证可用性
注意：适用于 Grafana Enterprise v7.4+。
GET /api/licensing/check
检查是否存在有效许可证。
所需权限
有关说明，请参阅 简介 中的注意事项。
| 操作 | 范围 |
|---|---|
| licensing:read | 不适用 |
示例
请求示例
GET /api/licensing/check
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk响应示例
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4
true状态码
- 200 - 成功
添加许可证
注意
适用于 Grafana Enterprise v7.4+。
POST /api/licensing/token
将许可证应用于 Grafana 实例。
所需权限
有关说明，请参阅 简介 中的注意事项。
| 操作 | 范围 |
|---|---|
| licensing:write | 不适用 |
示例
请求示例
POST /licensing/token
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0aGlzIjoiaXMiLCJub3QiOiJhIiwidmFsaWQiOiJsaWNlbnNlIn0.bxDzxIoJlYMwiEYKYT_l2s42z0Y30tY-6KKoyz9RuLE"}响应示例
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 357
{
"jti":"2",
"iss":"https://grafana.org.cn",
"sub":"https://play.grafana.org/"
"lid":"1",
"included_users":15,
"lic_exp_warn_days":30,
"tok_exp_warn_days":2,
"update_days":1,
"prod":["grafana-enterprise"],
"company":"Grafana Labs"
}响应是一个 JSON blob，用于调试。可用字段可能随时更改，恕不另行通知。
状态码
- 200 - 成功
- 400 - 错误请求
- 500 - 内部服务器错误（详情请参阅服务器日志）
手动强制刷新许可证
注意
适用于 Grafana Enterprise v7.4+。
POST /api/licensing/token/renew
手动向许可证颁发者请求新令牌。
所需权限
有关说明，请参阅 简介 中的注意事项。
| 操作 | 范围 |
|---|---|
| licensing:write | 不适用 |
示例
请求示例
POST /api/licensing/token/renew
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{}响应示例
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 357
{
"jti":"2",
"iss":"https://grafana.org.cn",
"sub":"https://play.grafana.org/"
"lid":"1",
"included_users":15,
"lic_exp_warn_days":30,
"tok_exp_warn_days":2,
"update_days":1,
"prod":["grafana-enterprise"],
"company":"Grafana Labs"
}响应是一个 JSON blob，用于调试。可用字段可能随时更改，恕不另行通知。
状态码
- 200 - 成功
- 401 - 未授权
- 403 - 访问被拒绝
从数据库中移除许可证
注意
适用于 Grafana Enterprise v7.4+。
DELETE /api/licensing/token
移除存储在 Grafana 数据库中的许可证。
所需权限
有关说明，请参阅 简介 中的注意事项。
| 操作 | 范围 |
|---|---|
| licensing:delete | 不适用 |
示例
请求示例
DELETE /api/licensing/token
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{"instance": "http://play.grafana.org/"}JSON 请求体 schema
- instance – 应删除许可证的实例的根 URL。必需。
响应示例
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 2
{}状态码
- 202 - 已接受，许可证已移除或不存在。
- 401 - 未授权
- 403 - 访问被拒绝
- 422 - 无法处理的实体，提供了不正确的实例名称。
