Prometheus API 使用了 JSON 格式的响应内容。 输入时间戳可以由 RFC3339 格式或者 Unix 时间戳提供,后面可选的小数位可以精确到亚秒级别。输出时间戳以 Unix 时间戳的方式呈现。所有的 API请求返回的格式均使用以下的 JSON 格式:
{
"status": "success" | "error",
"data": <data>,
// Only set if status is "error".
// additional data.
"errorType": "<string>",
"error": "<string>"
}
表达式查询
我们可以分别通过 /api/v1/query
和 /api/v1/query_range
查询 PromQL 表达式瞬时或者一定时间范围内的查询结果。当 API 调用成功后,Prometheus 会返回 JSON 格式的响应内容。
表达式查询结果会在 data 部分的 result 字段中返回以下的响应值。响应数据格式一共分为四种:
瞬时向量
通过使用 QUERY API
我们可以查询 PromQL 在特定时间点下的计算结果。
URL 请求参数:
query=<string> : PromQL 表达式。
time=<rfc3339 | unix_timestamp> : 用于指定用于计算 PromQL的时间戳。可选参数,默认情况下使用当前系统时间。
当 API 调用成功后,Prometheus 会返回 JSON 格式的响应内容,并且在 data 部分返回查询结果。data 部分格式如下:
{
"resultType":"vector",
"result": <value>
}
data
返回查询结果。value
指的是查询结果数据,具体的格式取决于resultType,不同的结果类型,会有不同的结果数据格式。瞬时数据的resultType为vector。区间数据的resultType为matrix。当返回数据类型 resultType 为 vector 时,是一组时间序列,每个时间序列包含单个样本。result 响应格式如下:
[
{
"metric": { "<label_name>": "<label_value>", ... },
"value": [ <unix_time>, "<sample_value>" ]
},
...
]
这个 url 的查询结果为当前时