菜单
开源

HTTP API Grafana米密尔

Grafana米密尔公开HTTP API,您可以使用它来编写和查询时间序列数据,和操作集群。

本文档组API端点的服务。注意,API端点接触当您运行Grafana米密尔在microservices模式下,单片模式,和读写模式:

  • Microservices模式:每个服务暴露自己的端点。
  • 单片模式实例:Grafana米密尔公开所有API端点。
  • 读写模式:组件服务端点,它们包含在暴露。米密尔读,米密尔写,或者米密尔的后端。指部署模式分组的组件。

端点

API 服务 端点
索引页 所有的服务 GET /
配置 所有的服务 GET /配置
配置状态 所有的服务 GET / api / v1 /地位/配置
状态标志 所有的服务 GET / api / v1 /地位/旗帜
运行时配置 所有的服务 GET / runtime_config
服务的状态 所有的服务 GET /服务
准备调查 所有的服务 准备好/
指标 所有的服务 GET /指标
Pprof 所有的服务 /调试/ pprof
Fgprof 所有的服务 /调试/ fgprof
构建信息 所有的服务 得到/ api / v1 /地位/ buildinfo
Memberlist集群 所有的服务 GET / memberlist
让租户的限制 所有的服务 GET / api / v1 / user_limits
远程写 经销商 POST / api / v1 /推动
OTLP 经销商 POST / otlp / v1 /指标
租户数据 经销商 获得/分销商/ all_user_stats
HA追踪状态 经销商 获得/分销商/ ha_tracker
冲洗块/块 摄取 GET、POST /吸收/冲洗
准备关闭 摄取 GET、POST、删除/吸收/ prepare-shutdown
关闭 摄取 GET、POST /吸收/关闭
Ingesters环状态 经销商,摄取 /吸收/环
即时查询 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 /查询
范围查询 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 / query_range
范例查询 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 / query_exemplars
被标签匹配器系列 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 /系列
获得标签名称 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 /标签
获取标签值 查询器,Query-frontend < prometheus-http-prefix > / api / v1 /标签/{名称}/值
得到指标元数据 查询器,Query-frontend 得到< prometheus-http-prefix > / api / v1 /元数据
远程读 查询器,Query-frontend 文章< prometheus-http-prefix > / api / v1 /阅读
标签名称基数 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 / / label_names基数
标签值基数 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 / / label_values基数
构建信息 查询器,Query-frontend统治者 < prometheus-http-prefix > / api / v1 /地位/ buildinfo
格式的查询 查询器,Query-frontend GET、POST < prometheus-http-prefix > / api / v1 / format_query
让租户摄入数据 查询器 GET / api / v1 / user_stats
Query-scheduler环状态 Query-scheduler 获得/ query-scheduler /环
统治者环状态 统治者 获得/统治者/环
统治者的规则 统治者 / / rule_groups统治者
普罗米修斯规则列表 统治者 得到< prometheus-http-prefix > / api / v1 /规则
普罗米修斯警报列表 统治者 得到< prometheus-http-prefix > / api / v1 /警报
规则组列表 统治者 得到< prometheus-http-prefix > / config / v1 /规则
被命名空间规则组 统治者 得到< prometheus-http-prefix > / config / v1 /规定/{名称}
得到规则组 统治者 < prometheus-http-prefix > / config / v1 /规定/{名称空间}/ {groupName}
设置规则组 统治者 文章< prometheus-http-prefix > / config / v1 /规定/{名称}
删除规则组 统治者 删除< prometheus-http-prefix > / config / v1 /规则/{名称空间}/ {groupName}
删除名称空间 统治者 删除< prometheus-http-prefix > / config / v1 /规定/{名称}
删除租户配置 统治者 POST /统治者/ delete_tenant_config
Alertmanager状态 Alertmanager / multitenant_alertmanager /状态
Alertmanager配置 Alertmanager 获得/ multitenant_alertmanager /款
Alertmanager环状态 Alertmanager 获得/ multitenant_alertmanager /环
Alertmanager UI Alertmanager 得到< alertmanager-http-prefix >
构建信息 Alertmanager < alertmanager-http-prefix > / api / v1 /地位/ buildinfo
Alertmanager删除租户配置 Alertmanager POST / multitenant_alertmanager / delete_tenant_config
得到Alertmanager配置 Alertmanager GET / api / v1 /警报
设置Alertmanager配置 Alertmanager POST / api / v1 /警报
删除Alertmanager配置 Alertmanager 删除/ api / v1 /警报
Store-gateway环状态 Store-gateway 获得/ store-gateway /环
Store-gateway租户 Store-gateway 获得/ store-gateway /租户
Store-gateway租户块 Store-gateway GET / store-gateway /租户/{租户}/块
准备关闭 Store-gateway GET、POST、删除/ store-gateway / prepare-shutdown
压实机环状态 压实机 压实机/环
块开始上传 压实机 POST / api / v1 /上传/块/{块}/开始
上传文件块 压实机 POST / api / v1 /上传/块/{块}/文件?路径= {path}
完整的块上传 压实机 POST / api / v1 /上传/块/{块}/完成
检查块上传 压实机 GET / api / v1 /上传/块/{块}/检查
租户删除请求 压实机 POST /压实机/ delete_tenant
租户删除状态 压实机 获得/压实机/ delete_tenant_status
Overrides-exporter环状态 Overrides-exporter 获得/ overrides-exporter /环

路径前缀

下表提供了使用占位符的路径前缀,前缀是可配置的。

前缀 默认的 CLI国旗 YAML的配置
< prometheus-http-prefix > /普罗米修斯 -http.prometheus-http-prefix api > prometheus_http_prefix
< alertmanager-http-prefix > / alertmanager -http.alertmanager-http-prefix api > alertmanager_http_prefix

身份验证

必须被称为端点需要身份验证X-Scope-OrgIDHTTP请求报头指定承租者ID。

如果你禁用多租户,Grafana米密尔不需要包括任何请求X-Scope-OrgID头。

多租户可以通过启用和禁用-auth.multitenancy-enabled国旗或其各自的YAML配置选项。

关于身份验证和授权的更多信息,请参考身份验证和授权

所有的服务

以下所有服务公开的API端点。

索引页

GET /

这个端点与到其他web页面的链接将显示一个索引页面暴露Grafana米密尔。

配置

GET /配置

这个端点显示当前配置应用于Grafana米密尔包括默认值和设置通过CLI旗帜。这个端点提供YAML格式的配置和面具敏感数据。

请注意:导出的配置不包括基本覆盖。

不同的模式

= diff /配置?模式

这个端点之间的差异显示Grafana米密尔默认配置和当前配置。

GET /配置?模式=违约

这个端点显示默认的配置值。

配置状态

GET / api / v1 /地位/配置

这个端点显示空配置设置,它只存在与普罗米修斯兼容/ api / v1 /地位/配置API。

状态标志

GET / api / v1 /地位/旗帜

这个端点显示空配置旗帜,它只存在与普罗米修斯兼容/ api / v1 /地位/旗帜API。

运行时配置

GET / runtime_config

这个端点显示运行时配置目前应用于Grafana米密尔,在YAML格式,包括默认值。端点是只能如果Grafana米密尔是配置了-runtime-config.file选择。

不同的模式

= diff / runtime_config ?模式

这个端点之间的差异显示Grafana米密尔默认运行时配置和当前运行时配置。

服务的状态

GET /服务

这个端点状态显示一个web页面的内部Grafana米密尔的服务。

准备调查

准备好/

这个endoint返回200年Grafana米密尔准备交通服务。

指标

GET /指标

这个端点返回运行的指标Grafana米密尔服务普罗米修斯博览会格式。

Pprof

获得/调试/ pprof /堆获得/调试/ pprof /块/调试/ pprof /配置文件获得/调试/ pprof /跟踪/调试/ pprof / goroutine /调试/ pprof /互斥

这些端点返回运行时分析数据所期望的格式pprof可视化工具。有许多事情可以描述使用该端点,包括堆,跟踪,goroutine等等。

关于pprof的更多信息,请参考pprof

Fgprof

/调试/ fgprof

这个端点返回抽样去分析数据,您可以使用它们来分析对cpu和Off-CPU(例如,I / O)时间。

关于fgprof的更多信息,请参考fgprof

构建信息

获得/ api / v1 /地位/ buildinfo < prometheus-http-prefix > / api / v1 /地位/ buildinfo得到< alertmanager-http-prefix > / api / v1 /地位/ buildinfo

这个端点返回JSON格式的信息构建和启用的特性。返回的格式是不一样的,但是类似于普罗米修斯构建信息端点

格式的查询

得到< prometheus-http-prefix > / api / v1 / format_query吗?查询查询={}发布< prometheus-http-prefix > / api / v1 / format_query

格式PromQL查询。

这个端点与普罗米修斯格式兼容查询端点。

查询有关格式的更多信息,请参考普罗米修斯的文档

Memberlist集群

GET / memberlist

这个admin页面显示信息Memberlist集群(节点列表和他们的健康)和KV商店(KV存储键和值)。

如果启用了memberlist消息历史,这个页面也显示所有接收和发送消息存储在缓冲区。这可以用于故障诊断memberlist集群。启用消息历史缓冲区使用-memberlist.message-history-buffer-bytesCLI国旗或相应的YAML配置参数。

让租户的限制

GET / api / v1 / user_limits

返回实时限制的经过身份验证的租户,JSON格式。这个API是实验性的。

需要身份验证

端点是只能如果Grafana米密尔是配置了-runtime-config.file选择。

经销商

下面的端点与经销商

远程写

POST / api / v1 /推动

入口点的普罗米修斯远程写

这个端点接受一个HTTP POST请求的身体包含请求编码协议缓冲区和压缩时髦的。你可以找到protobuf消息的定义包裹/ mimirpb / mimir.proto。HTTP请求必须包含的头X-Prometheus-Remote-Write-Version设置为0.1.0

跳过标签名字验证,执行以下操作:

  • 使API的国旗-api.skip-label-name-validation-header-enabled = true
  • 确保发送请求头X-Mimir-SkipLabelNameValidation:真

该特性支持非标准的写下游客户指标的名字不是普罗米修斯兼容。

普罗米修斯的更多信息,请参考远程存储集成

需要身份验证

OTLP

POST / otlp / v1 /指标

入口点的OTLP HTTP。实验。

这个端点接受一个HTTP POST请求的身体包含请求编码协议缓冲区和可选地压缩GZIP。你可以找到protobuf消息的定义metrics.proto

需要身份验证

经销商环状态

获得/分销商/环

这个端点显示一个web页面的分销商散列环状态,包括国家和每个经销商的健康和持续心跳时间。

租户数据

获得/分销商/ all_user_stats

这个端点显示一个web页面显示基本统计数据实时更新,包括所有ingesters活动系列的总数和当前摄入率每秒显示在样本。

注意:这个端点需要所有ingesters活跃的环的一个成功的响应。

HA追踪状态

获得/分销商/ ha_tracker

这个端点显示一个web页面的当前状态追踪,包括当选为每个普罗米修斯HA集群复制。

摄取

下面的端点与摄取

冲洗块/块

GET、POST /吸收/冲洗

这个端点触发刷新内存系列的时间序列数据长期存储。这个端点也触发时冲洗-blocks-storage.tsdb.flush-blocks-on-shutdown是禁用的。

这个端点接受一个租户参数指定的租户块压实和装运。这个参数可以指定多次选择更多的租户。如果没有指定租户,租户都脸红。

冲洗端点也接受等待= true参数,使调用同步,只有冲洗完成后返回一个状态码。

请注意:返回的状态码不反映冲洗操作的结果。

准备关闭

GET、POST、删除/吸收/ prepare-shutdown

这个端点检查或更改内存中摄取配置准备永久停止摄取实例,但实际上并没有停止摄取的任何部分。

帖子prepare-shutdown端点的回报,当摄取过程停止信号情报/SIGTERM从环,摄取将未注册和内存中的时间序列数据将刷新到长期储存。这个端点导致摄取从环未注册时停止即使你禁用-ingester.ring.unregister-on-shutdown

一个得到prepare-shutdown端点返回这个配置的状态设置

一个删除prepare-shutdown端点返回摄取到以前状态的配置(关于取消注册关闭和冲洗内存中的时间序列数据的长期存储)。

通常使用这个API端点Kubernetes-specific缩减自动化等rollout-operator

关闭

GET、POST /吸收/关闭

这个端点将内存中的时间序列数据从ingesters长期储存,然后关闭摄取服务。在关闭端点返回之后,操作员或任何使用终止该过程的自动化信号情报/SIGTERM信号。在这段时间里,/准备不返回200。这个端点注销的摄取戒指即使你禁用-ingester.ring.unregister-on-shutdown

这个API端点通常是缩小所使用的自动化。

TSDB指标

获得/吸收/ tsdb_metrics

这个端点返回底层指标的基本配置TSDB。这可以用于故障诊断。区别/指标指标中返回吗/指标是聚合所有TSDBs开放,而这个端点返回TSDB指标只对特定的租户。

需要身份验证返回,经过身份验证的租户的TSDB指标。

Ingesters环状态

/吸收/环

这个端点显示一个web页面的ingesters散列环状态,包括状态、健康、和最后的心跳时间每摄取。

查询器/ Query-frontend

下面的端点都暴露了查询器query-frontend

即时查询

GET、POST < prometheus-http-prefix > / api / v1 /查询

这个端点兼容普罗米修斯即时查询端点。

关于普罗米修斯即时查询的更多信息,请参阅普罗米修斯即时查询

需要身份验证

范围查询

GET、POST < prometheus-http-prefix > / api / v1 / query_range

这个端点兼容普罗米修斯范围查询端点。当客户端发送一个请求通过query-frontend query-frontend使用缓存和执行并行加速查询。

关于普罗米修斯范围查询的更多信息,请参阅普罗米修斯范围查询

需要身份验证

范例查询

GET、POST < prometheus-http-prefix > / api / v1 / query_exemplars

这个端点兼容普罗米修斯范例查询端点。

关于普罗米修斯范例查询的更多信息,请参阅普罗米修斯范例查询

需要身份验证

被标签匹配器系列

GET、POST < prometheus-http-prefix > / api / v1 /系列

普罗米修斯的更多信息,请参考系列端点

需要身份验证

获得标签名称

GET、POST < prometheus-http-prefix > / api / v1 /标签

普罗米修斯的更多信息,请参考获得标签名称

需要身份验证

获取标签值

< prometheus-http-prefix > / api / v1 /标签/{名称}/值

普罗米修斯的更多信息,请参考获取标签值

需要身份验证

得到指标元数据

得到< prometheus-http-prefix > / api / v1 /元数据

Prometheus-compatible指标元数据端点。

普罗米修斯的更多信息,请参考度量元数据

需要身份验证

远程读

文章< prometheus-http-prefix > / api / v1 /阅读

Prometheus-compatible远程读端点。

普罗米修斯的更多信息,请参考远程存储集成

需要身份验证

标签名称基数

GET、POST < prometheus-http-prefix > / api / v1 / / label_names基数

返回实时标签名称在所有ingesters基数,为经过身份验证的租户JSON格式。它数量不同的标签值/标签的名字。

至于这个端点生成基数报告只使用值从目前在ingesters TSDBs打开,两个后续调用会返回完全不同的结果,如果摄取了一块切之间的调用。

田野里的物品基数是按label_values_countDESC顺序label_nameASC秩序。

商品的数是有限的限制请求参数。

这个端点默认是禁用的,并且可以通过启用-querier.cardinality-analysis-enabledCLI标志(或其各自的YAML配置选项)。

需要身份验证

请求参数

  • 选择器- - - - - -可选——指定PromQL选择器将用于过滤系列,必须分析。
  • 限制- - - - - -可选——指定项目领域的最大计数基数在回应(默认= 20 min = 0, max = 500)

响应模式

{“label_values_count_total”: <数字>,“label_names_count”: <数字>,“基数”:[{“label_name”: <字符串>,“label_values_count”: <数字>}]}

标签值基数

GET、POST < prometheus-http-prefix > / api / v1 / / label_values基数

返回实时标签值基数相关的请求参数label_names []在所有ingesters,为经过身份验证的租户JSON格式。它返回系列数/标签请求参数相关联的值label_names []

至于这个端点生成基数报告只使用值从目前在ingesters TSDBs打开,两个后续调用会返回完全不同的结果,如果摄取了一块切之间的调用。

田野里的物品标签是按series_countDESC顺序label_nameASC秩序。田野里的物品基数是按series_countDESC顺序label_valueASC秩序。

的数基数项目由请求参数是有限的限制

这个端点默认是禁用的,并且可以通过启用-querier.cardinality-analysis-enabledCLI标志(或其各自的YAML配置选项)。

需要身份验证

请求参数

  • label_names []- - - - - -要求——指定基数必须提供标签。
  • 选择器- - - - - -可选——指定PromQL选择器将用于过滤系列,必须分析。
  • 限制- - - - - -可选——指定项目领域的最大计数基数在回应(默认= 20 min = 0, max = 500)。

响应模式

{“series_count_total”: <数字>,“标签”:[{“label_name”: <字符串>,“label_values_count”: <数字>,“series_count”: <数字>,“基数”:[{“label_value”: <字符串>,“series_count”: <数字>}]}]}
  • series_count_total——系列总数在打开TSDBs ingesters
  • 标签[].label_name——标签名称请求通过请求参数label_names []
  • 标签[].label_values_count-总数量的标签值标签名称(注意,依赖限制请求参数是可能的,并不是所有出现在标签值基数)
  • 标签[].series_count-系列的总数标签[].label_name
  • 标签[].cardinality [] .label_value——标签值相关标签[].label_name
  • 标签[].cardinality [] .series_count-系列的总数label_valuelabel_name

查询器

让租户摄入数据

GET / api / v1 / user_stats

返回实时摄取率,为经过身份验证的租户JSON格式。

需要身份验证

Query-scheduler

Query-scheduler环状态

获得/ query-scheduler /环

显示一个web页面的query-scheduler散列环状态,包括状态,每个query-scheduler健康持续心跳时间。query-scheduler环时才可用-query-scheduler.service-discovery-mode被设置为

统治者

统治者API端点需要配置一个后端对象存储来存储记录规则和警报。统治者API使用“名称空间”的概念在创建规则组。这是一个站在规则文件的名称在普罗米修斯和规则组必须在一个名叫独特的名称空间。

统治者环状态

获得/统治者/环

显示一个web页面的统治者希环状态,包括状态、健康和持续心跳时间的统治者。

统治者的规则

/ / rule_groups统治者

列出所有租户的规则。这个端点不属于ruler-API和总是不管ruler-API是否启用。它不应该暴露于最终用户。这个端点返回YAML字典和每个租户的所有规则组200年状态码成功。

普罗米修斯规则列表

得到< prometheus-http-prefix > / api / v1 /规则? type ={警报记录|}

Prometheus-compatible规则端点列表报警和记录当前加载的规则。

类型参数是可选的。如果设置,只返回指定类型的规则。

普罗米修斯的更多信息,请参考规则

需要身份验证

普罗米修斯警报列表

得到< prometheus-http-prefix > / api / v1 /警报

Prometheus-compatible规则端点的所有活动警报列表。

普罗米修斯的更多信息,请参考警报文档。

需要身份验证

规则组列表

得到< prometheus-http-prefix > / config / v1 /规则

列出所有规则配置的身份验证的租户。这个端点返回YAML字典为每个名称空间和所有的规则组200年状态码成功。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:从米密尔列出所有规则组,使用mimirtool规则列表命令

示例响应

推荐- - - - - - < namespace1 >: -名称:<字符串>间隔:<时间;可选> source_tenants: - <字符串>规则:-记录:<字符串> expr: <字符串> -警报:<字符串> expr: <字符串>:<时间>注释:< annotation_name >: <字符串>标签:< label_name >: <字符串> -名称:<字符串>间隔:<时间;可选> source_tenants: - <字符串>规则:-记录:<字符串> expr: <字符串> -警报:<字符串> expr: <字符串>:<时间>注释:< annotation_name >: <字符串>标签:< label_name >: <字符串> < namespace2 >: -名称:<字符串>间隔:<时间;可选> source_tenants: - <字符串>规则:-记录:<字符串> expr: <字符串> -警报:<字符串> expr: <字符串>:<时间>注释:< annotation_name >: <字符串>标签:< label_name >: <字符串>

被命名空间规则组

得到< prometheus-http-prefix > / config / v1 /规定/{名称}

返回给定名称空间定义的规则组。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

示例响应

名称:<字符串>间隔:<时间;可选> source_tenants: - <字符串>规则:-记录:<字符串> expr: <字符串> -警报:<字符串> expr: <字符串>:<时间>注释:< annotation_name >: <字符串>标签:< label_name >: <字符串>

得到规则组

< prometheus-http-prefix > / config / v1 /规定/{名称空间}/ {groupName}

返回请求匹配的规则组名称空间和组名。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:从米密尔检索一个规则组,使用mimirtool规则得到命令

设置规则组

POST / < prometheus-http-prefix > / config / v1 /规则/{名称}

创建或更新规则组。这个端点期望与要求内容类型:应用程序/ yaml头和规则组YAML请求中定义的身体,并返回202年在成功。请求主体必须包含一个且只有一个规则组的定义。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:将一个或多个规则组加载到米密尔,使用mimirtool规则加载命令

注意:当使用旋度发送请求的身体从一个文件中,确保您使用——data-binary国旗,而不是- d,——数据,或——data-ascii。后者的选择不保存回车和换行。

示例请求体

名称:MyGroupName规则:-警报:MyAlertName expr: = = 0标签:严重性:警告

删除规则组

删除/ < prometheus-http-prefix > / config / v1 /规则/{名称空间}/ {groupName}

删除规则组的名称空间和组名。这个端点返回202年在成功。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:从米密尔删除规则组,使用mimirtool规则删除命令

删除名称空间

删除/ < prometheus-http-prefix > / config / v1 /规定/{名称}

删除名称空间中的所有规则组(包括名称空间本身)。这个端点返回202年在成功。

这个端点可以通过禁用-ruler.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

删除租户配置

POST /统治者/ delete_tenant_config

这对租户删除所有规则组,并返回200年在成功。调用该端点当不存在规则组房客的回报200年。认证只是确定承租人。

这是内部API,而不是受到用户。无论是否启用此端点-ruler.enable-api是否启用。

需要身份验证

Alertmanager

Alertmanager状态

/ multitenant_alertmanager /状态

显示一个web页面Alertmanager的当前状态,包括Alertmanager集群成员。

Alertmanager配置

获得/ multitenant_alertmanager /款

列出所有Alertmanager配置。这个端点不是Alertmanager API的一部分,总是可用的无论Alertmanager API启用或不是。它不应该暴露于最终用户。这个端点返回YAML字典和所有Alertmanager配置200年状态码成功。

Alertmanager环状态

获得/ multitenant_alertmanager /环

显示一个web页面的Alertmanager散列环状态,包括状态、健康和持续心跳的时间每个Alertmanager实例。

Alertmanager UI

GET / < alertmanager-http-prefix >

显示Alertmanager UI。

需要身份验证

Alertmanager删除租户配置

POST / multitenant_alertmanager / delete_tenant_config

这个端点为租户被删除配置X-Scope-OrgID头。可用的内部,即使Alertmanager API是禁用的。端点返回的状态码200年如果用户的配置已被删除或不存在的。

需要身份验证

得到Alertmanager配置

GET / api / v1 /警报

获取当前Alertmanager配置身份验证的租户,阅读它的对象存储配置。

这个端点不接受任何URL查询参数并返回200年在成功。

这个端点可以通过启用和禁用-alertmanager.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:从米密尔检索一个租户的Alertmanager配置,使用mimirtool alertmanager得到命令

设置Alertmanager配置

POST / api / v1 /警报

商店或更新的Alertmanager配置身份验证的租户。Alertmanager配置存储在配置后端对象存储。

这个端点预计AlertmanagerYAML配置请求中身体和回报201年在成功。

这个端点可以通过启用和禁用-alertmanager.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:加载一个租户的米密尔Alertmanager配置,使用mimirtool alertmanager负载命令

注意:当使用旋度发送请求的身体从一个文件中,确保您使用——data-binary国旗,而不是- d,——数据,或——data-ascii。后者的选择不保存回车和换行。

示例请求体

template_files: default_template: |{{定义“__alertmanager}} AlertManager{{结束}}{{定义“__alertmanagerURL}} {{.ExternalURL}} / # /警报?接收机= {{.Receiver | urlquery}}{{结束}}alertmanager_config: |全球:smtp_smarthost: localhost: 25的smtp_from:“youraddress@example.org”模板:——“default_template”路线:接收机:example-email接收器:-名称:example-email email_configs:——:“youraddress@example.org”

删除Alertmanager配置

删除/ api / v1 /警报

删除的Alertmanager配置身份验证的租户。

这个端点不接受任何URL查询参数并返回200年在成功。

这个端点可以通过启用和禁用-alertmanager.enable-apiCLI标志(或其各自的YAML配置选项)。

需要身份验证

注意:从米密尔删除租户的Alertmanager配置,使用mimirtool alertmanager删除命令

Store-gateway

Store-gateway环状态

获得/ store-gateway /环

显示一个web页面的store-gateway散列环状态,包括状态,每个store-gateway健康持续心跳时间。

Store-gateway租户

获得/ store-gateway /租户

显示一个web页面的列表租户的块存储为store-gateway配置。

Store-gateway租户块

GET / store-gateway /租户/{租户}/块

显示一个web页面清单给租户的街区。

准备关闭

GET、POST、删除/ store-gateway / prepare-shutdown

这个端点更改内存store-gateway配置准备永久停止但实际上并没有阻止store-gateway实例的任何部分。

帖子prepare-shutdown端点的回报,当store-gateway过程停止信号情报/SIGTERM从环,store-gateway将未注册。

一个得到prepare-shutdown端点返回这个配置的状态设置

一个删除prepare-shutdown端点返回store-gateway到以前状态的配置(关于取消注册)。

通常使用这个API端点Kubernetes-specific缩减自动化等rollout-operator

压实机

压实机环状态

压实机/环

显示一个web页面与压实机散列环状态,包括状态、健康和持续心跳时间压实机。

块开始上传

POST / api / v1 /上传/块/{块}/开始

开始上传TSDB块与给定ID的对象存储。客户端应该发送块的meta.json文件作为请求主体。如果在对象存储完整的块已经存在,409年(冲突)状态码被返回。如果所提供的meta.json文件是无效的400年(坏的请求)状态码被返回。如果块的最大时间是前房客的保存期,a422年(Unprocessable实体)状态码被返回。

所提供的meta.json文件必须有一个thanos.files节块的文件列表,否则请求将被拒绝。

如果API请求成功,块的净化版本meta.json文件被上传到对象存储uploading-meta.json和一个200年状态代码被返回。然后你就可以开始上传文件,一旦完成,您可以请求完成上传。

需要身份验证

上传文件块

POST / api / v1 /上传/块/{块}/文件?路径= {path}

上传一个文件与给定路径,一块与给定ID。文件路径必须是下列之一,否则400年(坏的请求)返回状态代码:

  • 指数
  • 块/ <数字>

客户端必须发送的内容文件请求的主体;如果身体是空的,一个400年(坏的请求)状态码被返回。如果在对象存储完整的块已经存在,409年(冲突)状态码被返回。如果一个动态元文件(uploading-meta.json)不存在在对象存储块的问题,404年(未找到)状态码被返回。

如果API请求成功,用给定的路径文件被上传块在对象存储的目录,以及一个200年状态代码被返回。

需要身份验证

完整的块上传

POST / api / v1 /上传/块/{块}/完成

启动完成TSDB块与给定ID对象存储。如果在对象存储完整的块已经存在,409年(冲突)状态码被返回。如果一个动态元文件(uploading-meta.json)不存在在对象存储块的问题,404年(未找到)状态码被返回。如果压缩机已经达到限制的最大并发数块上传验证,配置了-compactor.max-block-upload-validation-concurrency,一个429年将返回(太多的请求)。

如果API请求成功,压缩机将启动块在后台验证。如果后台验证通过块上传完成后通过重命名动态元文件meta.json块的目录。

这个API端点返回200年(好)的验证。进一步的检查状态块上传、使用检查块上传API端点。

需要身份验证

这个API端点实验和可能发生变化。

检查块上传

GET / api / v1 /上传/块/{块}/检查

返回的状态块上传。国家返回JSON对象字段结果,可能的值:

  • 完整的——块验证完成,现在块上传完成。
  • 上传块还在上传,完整的块上传尚未呼吁。
  • 验证——块被验证。验证是由调用完整的块上传API。
  • 失败的——块验证失败了。错误信息是可用的错误返回的JSON对象。

示例响应

{“结果”:“上传”}

示例响应

{“结果”:“失败”、“错误”:“失踪索引文件”}

需要身份验证

这个API端点实验和可能发生变化。

租户删除请求

POST /压实机/ delete_tenant

请求删除所有租户的数据。

需要身份验证

租户删除状态

获得/压实机/ delete_tenant_status

返回删除租户的地位。

响应模式

{“tenant_id”:“< id >”,“blocks_deleted”:真正的}

blocks_deleted字段将被设置为真正的如果所有的租户的街区已被删除。

需要身份验证

Overrides-exporter

Overrides-exporter环状态

获得/ overrides-exporter /环

显示一个web页面的overrides-exporter散列环状态,包括状态,每个overrides-exporter健康持续心跳时间。overrides-exporter环时才可用-overrides-exporter.ring.enabled被设置为真正的