Prometheus HTTP API

本文档介绍了Prometheus HTTP API的基本用法,包括查询表达式的使用和API响应的格式。用户可以通过API获取时间序列数据,API响应以JSON格式返回,错误情况会返回相应的HTTP错误代码。表达式查询是API的重要部分,允许对Prometheus中的数据进行检索。
摘要由CSDN通过智能技术生成

完整译文请访问http://www.coderdocument.com/docs/prometheus/v2.14/prometheus/querying/http_api.html

当前稳定的HTTP API可以在Prometheus服务器上的/api/v1 下访问。所有非破坏性的API都将被添加到该端点下。

格式概览

API响应格式是JSON。每个成功的API请求都返回一个2xx状态码。

到达API处理器的无效请求将返回一个JSON错误对象和以下HTTP响应代码之一:

  • 400 Bad Request:当参数缺失或不正确
  • 422 Unprocessable Entity:表达式不能被执行(RFC4918
  • 503 Service Unavailable:查询超时或中止

如果在到达API端点之前发生错误,可能会返回其他非2xx状态码。

如果有错误不能阻止请求执行,可能会返回一个警告数组。成功收集的所有数据都将在data字段中返回。

JSON响应格式如下:

{
  "status": "success" | "error",
  "data": <data>,
  // Only set if status is "error". The data field may still hold
  // additional data.
  "errorType": "<string>",
  "error": "<string>",
  // Only if there were warnings while executing the request.
  // There will still be data in the data field.
  "warnings": ["<string>"]
}

输入时间戳可以以RFC3339格式提供;也可以是秒为单位的Unix时间戳,可选的小数位数表示秒精度。输出时间戳总是表示为Unix时间戳(以秒为单位)。

可以重复的查询参数的名称以[]结尾。

<series_selector>占位符指的是Prometheus时间序列选择器,例如http_requests_totalhttp_requests_total{method=~"(GET|POST),并且需要进行URL编码。

<duration>占位符指的是Prometheus格式的持续时间字符串,修理工为[0-9]+[smhdwy]。例如,5m表示持续时间为5分钟。

<bool>占位符指的是布尔值(字符串truefalse)。

表达式查询

完整译文请访问http://www.coderdocument.com/docs/prometheus/v2.14/prometheus/querying/http_api.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值