菜单
Grafana企业日志 凝胶的api 管理API
企业

管理API

注意:管理API版本v1 / Admin / API / v1 / v2 / Admin / API / v2 /端点弃用和将被删除在以后版本的凝胶。使用新的管理API版本v3端点/ Admin / API / v3 /。

在下面的例子中,环境变量API_TOKEN包含管理令牌。指生成一个管理令牌。

还可以创建租户访问政策和令牌使用插件。

租户

租户是由以下字段:

  • 的名字租户:机器可读名称。它必须在3到64个字符之间,只包括以下字符,[a-z0-9 _)。一旦设置,这个领域是不可变的。
  • display_name租户:人类可读名称。它可以包含任何的字符集和可以改变。
  • 状态:这个租户的现状。它可以有以下值:
    • 活跃的
    • 不活跃的
    • 未知的
  • 集群:凝胶集群的名称,这个房客是作用域。你只能写或查询这个租户从这个集群。

租户名单

GET / admin / api / v1 /实例GET / admin / api / v2 /租户

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点GET / admin / api / v3 /租户代替。

GET / admin / api / v3 /租户

注:

  • 这在一个端点只返回租户活跃的的地位。所有租户包括不活跃的使用查询参数include-non-active = true

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 /租户|金桥{“物品”:[{“名称”:“enterprise-logs-dev”,“display_name”:“dev租户Grafana企业日志”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“集群”:“dev-cluster”}],“类型”:“租户”}

创建一个租户

发布/管理/ api / v1 /实例发布/管理/ api / v2 /租户

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点发布/管理/ api / v3 /租户代替。

发布/管理/ api / v3 /租户

因为租户名称是独一无二的,你不能用相同的名称创建一个新的租户,租户已经存在但在不活跃的状态。相反,再次使用相同的租户名称必须启用不活跃的租户通过更新其状态活跃的。这种变化,使用更新的房客端点。当创建一个租户通过这个API调用,它不需要指定状态场,因为地位总是覆盖的API活跃的。

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 /租户\——数据”{“名称”:“开发”,“display_name”:“dev租户Grafana企业日志”,“集群”:“dev-cluster“}”

更新的房客

把/ admin / api / v1 /实例/{名称}把/ admin / api / v2 /租户/{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点把/ admin / api / v3 /租户代替。

把/ admin / api / v3 /租户/{名称}

例子:

curl - u: $ API_TOKEN localhost: 3100 / admin / api / v3 /租户/ enterprise-logs-dev \ - x将- h If-Match:“123”的\——数据”{“display_name”:“dev租户Grafana企业日志”,“状态”:“活跃”,“集群”:“dev-cluster”}”|金桥{“名称”:“enterprise-logs-dev”,“display_name”:“dev租户Grafana企业日志”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“集群”:“dev-cluster”}

读租户细节

得到/ admin / api / v1 /实例/{名称}GET / admin / api / v2 /租户/{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点GET / admin / api / v3 /租户/{名称}代替。

GET / admin / api / v3 /租户/{名称}

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 /租户/ enterprise-logs-dev |金桥{“名称”:“enterprise-logs-dev”,“display_name”:“dev租户Grafana企业日志”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“集群”:“dev-cluster”}

删除一个租户

删除/ admin / api / v1 /实例/{名称}删除/ admin / api / v2 /租户/{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。在管理API版本v3,删除操作不再支持,取而代之的是软删除。使用的端点把/ admin / api / v3 /租户/{名称}与“状态”:“不活跃”代替。这个操作将灭活租户的租户和随后的HTTP请求将失败401未经授权的HTTP状态代码。重新启用一个租户,使用端点把/ admin / api / v3 /租户/{名称}与“状态”:“活跃”。

把/ admin / api / v3 /租户/{名称}

示例API调用标记一个租户活动:

curl - u: $ API_TOKEN localhost: 3100 / admin / api / v3 /租户/ enterprise-logs-dev \ - x将- h If-Match:“123”的\——数据“{”状态”:“不活跃”,“集群”:“dev-cluster”}”|金桥{“名称”:“enterprise-logs-dev”,“display_name”:“dev租户Grafana企业日志”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“不活跃”、“集群”:“dev-cluster”}

访问策略

一个访问政策由以下字段:

  • 的名字:机器可读名称的政策。
  • display_name租户:人类可读名称。它可以包含任何的字符集和可以改变。
  • created_at:一个RFC3339格式化日期时间。
  • 领域:服务器的列表。
  • 作用域:作用域的列表。

一个王国的租户/集群对指定访问政策允许请求:

  • 租户:你必须在现有租户或设置这个字段*。*,表示访问所有租户。
  • 集群:你必须将这个字段设置为现有的集群。

范围指定操作什么令牌,被分配到这个访问政策,能够执行时调用凝胶API。

  • 日志:阅读:从租户视图数据的权限。
  • 日志:写租户:允许写入数据。
  • 日志:删除:从租户权限删除数据。
  • 管理:允许执行管理操作。

列表访问策略

得到/ admin / api / v1 / accesspolicies得到/ admin / api / v2 / accesspolicies

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点得到/ admin / api / v3 / accesspolicies代替。

得到/ admin / api / v3 / accesspolicies

注:

  • 这在一个端点只返回访问策略活跃的的地位。所有的访问策略包括不活跃的使用查询参数include-non-active = true

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 / accesspolicies |金桥{“物品”:[{“名称”:“ap1”,“display_name”:“首先访问政策”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}],“范围”:[“日志:阅读”、“日志:写“]},],“类型”:“access_policy”}

创建访问策略

发布/管理/ api / v1 / accesspolicies发布/管理/ api / v2 / accesspolicies

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点发布/管理/ api / v3 / accesspolicies代替。

发布/管理/ api / v3 / accesspolicies

因为访问政策的名称是独一无二的,你不能用相同的名称创建一个新的访问策略作为一个已经存在但在访问政策不活跃的状态。相反,再次使用相同的访问策略名称必须启用不活跃的访问政策通过更新其状态活跃的。这种变化,使用更新访问政策端点。当创建一个访问策略通过这个API调用,它不需要指定状态场,因为地位总是覆盖的API活跃的。

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 / accesspolicies \——数据”{“名称”:“ap1”,“display_name”:“首先访问政策”,\“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”, \“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}], \“范围”:[“日志:阅读”、“日志:写“}”

更新访问政策

把/ admin / api / v1 / accesspolicies /{名称}把/ admin / api / v2 / accesspolicies /{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点把/ admin / api / v3 / accesspolicies /{名称}代替。

把/ admin / api / v3 / accesspolicies /{名称}

例子:

curl - u: $ API_TOKEN localhost: 3100 / admin / api / v3 / accesspolicies enterprise-logs-dev \ - x将- h If-Match:“123”的\——数据”{“display_name”:“首先访问政策”,\“状态”:“活跃”,\“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}], \“范围”:[“日志:阅读”、“日志:写“}”|金桥{“名称”:“ap1”,“display_name”:“首先访问政策”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}],“范围”:[“日志:阅读”、“日志:写”)}

获得政策

GET / admin / api / v1 / accesspolicies /{名称}GET / admin / api / v2 / accesspolicies /{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点GET / admin / api / v3 / accesspolicies /{名称}代替。

GET / admin / api / v3 / accesspolicies /{名称}

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 / accesspolicies ap1 |金桥{“名称”:“ap1”,“display_name”:“首先访问政策”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”,“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}],“范围”:[“日志:阅读”、“日志:写”)}

删除访问政策

删除/ admin / api / v1 / accesspolicies /{名称}删除/ admin / api / v2 / accesspolicies /{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。在管理API版本v3,删除操作不再支持,取而代之的是软删除。使用的端点把/ admin / api / v3 / accesspolicies /{名称}与“状态”:“不活跃”代替。这个操作将灭活一个访问政策和随后的HTTP请求有一个关联的令牌将失败401未经授权的HTTP状态代码。重新启用一个访问策略,使用的端点把/ admin / api / v3 / accesspolicies /{名称}与“状态”:“活跃”。

把/ admin / api / v3 / accesspolicies /{名称}

示例API调用设置一个访问政策不活跃的状态:

curl - u: $ API_TOKEN localhost: 3100 / admin / api / v3 / accesspolicies enterprise-logs-dev \ - x将- h If-Match:“123”的\——数据“{”状态”:“不活跃”,“display_name”:“首先访问政策”,\“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}], \“范围”:[“日志:阅读”、“日志:写“}”|金桥{“名称”:“ap1”,“display_name”:“首先访问政策”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“不活跃”、“领域”:[{“租户”:“enterprise-logs-dev”、“集群”:“dev-cluster”}],“范围”:[“日志:阅读”、“日志:写”)}

令牌

一个令牌是由以下字段:

  • 的名字:机器可读名称的政策。
  • display_name租户:人类可读名称。它可以包含任何的字符集和可以改变。
  • created_at:一个RFC3339格式化日期时间。
  • 过期:一个RFC3339格式化日期时间。
  • access_policy:的名称访问政策

创建一个令牌

发布/管理/ api / v1 /令牌发布/管理/ api / v2 /令牌

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点发布/管理/ api / v3 /令牌代替。

发布/管理/ api / v3 /令牌

因为令牌名称是独一无二的,你不能用相同的名称创建一个新的令牌,令牌已经存在但在不活跃的状态。相反,再次用同样的名字你必须启用不活跃的令牌通过更新其状态活跃的。这种变化,使用把/ admin / api / v3 /令牌/{名称}端点。通过这个API调用创建一个令牌时,它不需要指定状态场,因为地位总是覆盖的API活跃的。

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 /令牌\——数据”{“名称”:“devtoken”,“display_name”:“Dev牌”,\“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”, \“过期”:“2021 - 03 - 01 t17:37:59.341728283z”, \“access_policy”:“ap1“}”

获得令牌

GET / admin / api / v1 /令牌/{名称}GET / admin / api / v2 /令牌/{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。使用的端点GET / admin / api / v3 /令牌/{名称}代替。

GET / admin / api / v3 /令牌/{名称}

注:

  • 当前版本的令牌将被返回ETag头在响应。

例子:

curl - u:美元API_TOKEN localhost: 3100 / admin / api / v3 /令牌/ logs-enterprise-token |金桥{“名称”:“logs-enterprise-token”,“display_name”:“Grafana企业日志Dev牌”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“活跃”、“access_policy”:“ap1”、“过期”:“2021 - 03 - 01 - t17:37:59.341728283z”}

删除一个令牌

删除/ admin / api / v1 /令牌/{名称}删除/ admin / api / v2 /令牌/{名称}

弃用:这些端点弃用,会在将来的版本中被删除的凝胶。在管理API版本v3,删除操作不再支持,取而代之的是软删除。使用的端点把/ admin / api / v3 /令牌/{名称}与“状态”:“不活跃”代替。这个操作将灭活的令牌和随后的HTTP请求令牌将失败401未经授权的HTTP状态代码。要重新启用一个令牌,使用端点把/ admin / api / v3 /令牌/{名称}与“状态”:“活跃”。

把/ admin / api / v3 /令牌/{名称}

{“状态”:“不活跃”}

注:

  • If-Match标题匹配当前版本是必需的。

例子:

curl - u: $ API_TOKEN localhost: 8080 / admin / api / v3 /令牌/ logs-enterprise-token \ - x将- h If-Match:“123”的\——数据“{”状态”:“不活跃”}’|金桥{“名称”:“logs-enterprise-token”,“display_name”:“Grafana企业日志Dev牌”,“created_at”:“2021 - 02 - 01 t17:37:59.341728283z”,“状态”:“不活跃”、“access_policy”:“ap1”、“过期”:“2021 - 03 - 01 - t17:37:59.341728283z”}

确认你可以写入数据到你的凝胶租户

下面的命令将一个日志行通过使用洛基API。的令牌环境变量包含前创建令牌。的值1612951327316545500是当前Unix纪元的时间写在纳秒的时间;调整当前时间。在Linux上,可以使用日期+ % s % N命令:

日期+ % s % N 1612951327316545500美元

接下来,使用时间戳将日志:

curl - u:美元令牌localhost: 3100 /洛基/ api / v1 /推动\ - h“application / json内容类型:\ - h \“X-Scope-OrdID: dev”——数据”{“流”:[{“流”:{“工作”:“例子”},“值”:[[“1612951327316545500”,“一个日志线”]]}]}”