当前稳定的 HTTP API 可在 Prometheus 服务器上的 /api/v1 下访问。任何非破坏性的添加都将在此端点下添加。
API 响应格式为 JSON。每个成功的 API 请求都会返回 2xx 状态代码。
到达 API 处理程序的无效请求将返回 JSON 错误对象和以下 HTTP 响应代码之一
400 Bad Request 当参数缺失或不正确时。422 Unprocessable Entity 当无法执行表达式时 (RFC4918)。503 Service Unavailable 当查询超时或中止时。对于在到达 API 端点之前发生的错误，可能会返回其他非 2xx 代码。
如果存在不阻止请求执行的错误，则可能会返回警告数组。对于可能或可能不是误报的潜在查询问题，可能会返回额外的 info 级注释数组。成功收集的所有数据都将在数据字段中返回。
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 set if there were warnings while executing the request.
// There will still be data in the data field.
"warnings": ["<string>"],
// Only set if there were info-level annnotations while executing the request.
"infos": ["<string>"]
}
通用占位符定义如下
<rfc3339 | unix_timestamp>：输入时间戳可以以 RFC3339 格式或以秒为单位的 Unix 时间戳提供，可选的小数位用于亚秒级精度。输出时间戳始终表示为以秒为单位的 Unix 时间戳。<series_selector>：Prometheus 时间序列选择器，如 http_requests_total 或 http_requests_total{method=~"(GET|POST)"}，需要进行 URL 编码。<duration>：使用时间单位的 Prometheus 浮点字面值的子集。例如，5m 表示持续 5 分钟。<bool>：布尔值（字符串 true 和 false）。注意：可能重复的查询参数的名称以 [] 结尾。
查询语言表达式可以在单个瞬间或一段时间范围内进行评估。以下部分描述了每种类型的表达式查询的 API 端点。
以下端点在单个时间点评估即时查询
GET /api/v1/query
POST /api/v1/query
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。time=<rfc3339 | unix_timestamp>：评估时间戳。可选。timeout=<duration>：评估超时。可选。默认值和上限由 -query.timeout 标志的值决定。如果省略 time 参数，则使用当前服务器时间。
您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这非常有用。
查询结果的 data 部分具有以下格式
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}
<value> 指的是查询结果数据，其格式因 resultType 而异。请参阅 表达式查询结果格式。
以下示例在时间 2015-07-01T20:10:51.781Z 评估表达式 up
$ curl 'https://127.0.0.1:9090/api/v1/query?query=up&time=2015-07-01T20:10:51.781Z'
{
"status" : "success",
"data" : {
"resultType" : "vector",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"value": [ 1435781451.781, "1" ]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9100"
},
"value" : [ 1435781451.781, "0" ]
}
]
}
}
以下端点在一段时间范围内评估表达式查询
GET /api/v1/query_range
POST /api/v1/query_range
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。start=<rfc3339 | unix_timestamp>：开始时间戳，包括在内。end=<rfc3339 | unix_timestamp>：结束时间戳，包括在内。step=<duration | float>：查询分辨率步长，格式为 duration 或秒为单位的浮点数。timeout=<duration>：评估超时。可选。默认值和上限由 -query.timeout 标志的值决定。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这非常有用。
查询结果的 data 部分具有以下格式
{
"resultType": "matrix",
"result": <value>
}
有关 <value> 占位符的格式，请参阅 范围向量结果格式。
以下示例在 30 秒范围内评估表达式 up，查询分辨率为 15 秒。
$ curl 'https://127.0.0.1:9090/api/v1/query_range?query=up&start=2015-07-01T20:10:30.781Z&end=2015-07-01T20:11:00.781Z&step=15s'
{
"status" : "success",
"data" : {
"resultType" : "matrix",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"values" : [
[ 1435781430.781, "1" ],
[ 1435781445.781, "1" ],
[ 1435781460.781, "1" ]
]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
"values" : [
[ 1435781430.781, "0" ],
[ 1435781445.781, "0" ],
[ 1435781460.781, "1" ]
]
}
]
}
}
以下端点以美化的方式格式化 PromQL 表达式
GET /api/v1/format_query
POST /api/v1/format_query
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这非常有用。
查询结果的 data 部分是一个包含格式化查询表达式的字符串。请注意，所有注释都在格式化字符串中删除。
以下示例格式化表达式 foo/bar
$ curl 'https://127.0.0.1:9090/api/v1/format_query?query=foo/bar'
{
"status" : "success",
"data" : "foo / bar"
}
此端点是实验性的，将来可能会更改。目前它仅供 Prometheus 自己的 Web UI 使用，并且返回的端点名称和确切格式可能会因 Prometheus 版本而异。如果 UI 不再需要它，也可能会再次删除它。
以下端点解析 PromQL 表达式并将其作为 JSON 格式的 AST（抽象语法树）表示形式返回
GET /api/v1/parse_query
POST /api/v1/parse_query
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这非常有用。
查询结果的 data 部分是一个包含已解析查询表达式的 AST 的字符串。
以下示例解析表达式 foo/bar
$ curl 'https://127.0.0.1:9090/api/v1/parse_query?query=foo/bar'
{
"data" : {
"bool" : false,
"lhs" : {
"matchers" : [
{
"name" : "__name__",
"type" : "=",
"value" : "foo"
}
],
"name" : "foo",
"offset" : 0,
"startOrEnd" : null,
"timestamp" : null,
"type" : "vectorSelector"
},
"matching" : {
"card" : "one-to-one",
"include" : [],
"labels" : [],
"on" : false
},
"op" : "/",
"rhs" : {
"matchers" : [
{
"name" : "__name__",
"type" : "=",
"value" : "bar"
}
],
"name" : "bar",
"offset" : 0,
"startOrEnd" : null,
"timestamp" : null,
"type" : "vectorSelector"
},
"type" : "binaryExpr"
},
"status" : "success"
}
Prometheus 提供了一组 API 端点来查询有关序列及其标签的元数据。
以下端点返回与特定标签集匹配的时间序列列表。
GET /api/v1/series
POST /api/v1/series
URL 查询参数
match[]=<series_selector>：重复的序列选择器参数，用于选择要返回的序列。必须提供至少一个 match[] 参数。start=<rfc3339 | unix_timestamp>：开始时间戳。end=<rfc3339 | unix_timestamp>：结束时间戳。limit=<number>：返回的最大序列数。可选。0 表示禁用。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大量或动态序列选择器时，这非常有用。
查询结果的 data 部分由包含标签名称/值对的对象列表组成，这些标签名称/值对标识每个序列。
以下示例返回与选择器 up 或 process_start_time_seconds{job="prometheus"} 匹配的所有序列
$ curl -g 'https://127.0.0.1:9090/api/v1/series?' --data-urlencode 'match[]=up' --data-urlencode 'match[]=process_start_time_seconds{job="prometheus"}'
{
"status" : "success",
"data" : [
{
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
{
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
{
"__name__" : "process_start_time_seconds",
"job" : "prometheus",
"instance" : "localhost:9090"
}
]
}
以下端点返回标签名称列表
GET /api/v1/labels
POST /api/v1/labels
URL 查询参数
start=<rfc3339 | unix_timestamp>：开始时间戳。可选。end=<rfc3339 | unix_timestamp>：结束时间戳。可选。match[]=<series_selector>：重复的序列选择器参数，用于选择从中读取标签名称的序列。可选。limit=<number>：返回的最大序列数。可选。0 表示禁用。JSON 响应的 data 部分是字符串标签名称的列表。
这是一个示例。
$ curl 'localhost:9090/api/v1/labels'
{
"status": "success",
"data": [
"__name__",
"call",
"code",
"config",
"dialer_name",
"endpoint",
"event",
"goversion",
"handler",
"instance",
"interval",
"job",
"le",
"listener_name",
"name",
"quantile",
"reason",
"role",
"scrape_job",
"slice",
"version"
]
}
以下端点返回给定标签名称的标签值列表
GET /api/v1/label/<label_name>/values
URL 查询参数
start=<rfc3339 | unix_timestamp>：开始时间戳。可选。end=<rfc3339 | unix_timestamp>：结束时间戳。可选。match[]=<series_selector>: 重复的序列选择器参数，用于选择从中读取标签值的序列。 可选。limit=<number>：返回的最大序列数。可选。0 表示禁用。JSON 响应的 data 部分是字符串标签值的列表。
此示例查询 http_status_code 标签的所有标签值
$ curl https://127.0.0.1:9090/api/v1/label/http_status_code/values
{
"status" : "success",
"data" : [
"200",
"504"
]
}
标签名称可以选择使用值转义方法进行编码，如果名称包含 / 字符，则必须进行编码。要以此方式编码名称
U__。_20_，. 变为 _2e_。有关文本转义的更多信息，请参阅原始的 UTF-8 提案文档。
此示例查询 http.status_code 标签的所有标签值
$ curl https://127.0.0.1:9090/api/v1/label/U__http_2e_status_code/values
{
"status" : "success",
"data" : [
"200",
"404"
]
}
这是实验性的，将来可能会发生变化。以下端点返回特定时间范围的有效 PromQL 查询的示例列表
GET /api/v1/query_exemplars
POST /api/v1/query_exemplars
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。start=<rfc3339 | unix_timestamp>：开始时间戳。end=<rfc3339 | unix_timestamp>：结束时间戳。$ curl -g 'https://127.0.0.1:9090/api/v1/query_exemplars?query=test_exemplar_metric_total&start=2020-09-14T15:22:25.479Z&end=2020-09-14T15:23:25.479Z'
{
"status": "success",
"data": [
{
"seriesLabels": {
"__name__": "test_exemplar_metric_total",
"instance": "localhost:8090",
"job": "prometheus",
"service": "bar"
},
"exemplars": [
{
"labels": {
"trace_id": "EpTxMJ40fUus7aGY"
},
"value": "6",
"timestamp": 1600096945.479
}
]
},
{
"seriesLabels": {
"__name__": "test_exemplar_metric_total",
"instance": "localhost:8090",
"job": "prometheus",
"service": "foo"
},
"exemplars": [
{
"labels": {
"trace_id": "Olp9XHlq763ccsfa"
},
"value": "19",
"timestamp": 1600096955.479
},
{
"labels": {
"trace_id": "hCtjygkIHwAN9vs4"
},
"value": "20",
"timestamp": 1600096965.489
}
]
}
]
}
表达式查询可能会在 data 部分的 result 属性中返回以下响应值。<sample_value> 占位符是数字样本值。JSON 不支持特殊浮点值，例如 NaN、Inf 和 -Inf，因此样本值以带引号的 JSON 字符串而不是原始数字传输。
仅当响应中存在实验性的原生直方图时，才会显示键 "histogram" 和 "histograms"。它们的占位符 <histogram> 将在其自己的部分中详细解释。
范围向量以结果类型 matrix 返回。相应的 result 属性具有以下格式
[
{
"metric": { "<label_name>": "<label_value>", ... },
"values": [ [ <unix_time>, "<sample_value>" ], ... ],
"histograms": [ [ <unix_time>, <histogram> ], ... ]
},
...
]
每个序列可能具有 "values" 键、"histograms" 键或两者都具有。对于给定的时间戳，只会有一个浮点数或直方图类型的样本。
序列按 metric 排序返回。诸如 sort 和 sort_by_label 之类的函数对范围向量没有影响。
即时向量以结果类型 vector 返回。相应的 result 属性具有以下格式
[
{
"metric": { "<label_name>": "<label_value>", ... },
"value": [ <unix_time>, "<sample_value>" ],
"histogram": [ <unix_time>, <histogram> ]
},
...
]
每个序列可能具有 "value" 键或 "histogram" 键，但不能同时具有两者。
除非使用诸如 sort 或 sort_by_label 之类的函数，否则不保证序列以任何特定顺序返回。
标量结果以结果类型 scalar 返回。相应的 result 属性具有以下格式
[ <unix_time>, "<scalar_value>" ]
字符串结果以结果类型 string 返回。相应的 result 属性具有以下格式
[ <unix_time>, "<string_value>" ]
上面使用的 <histogram> 占位符的格式如下。
请注意，原生直方图是一项实验性功能，下面的格式可能仍然会发生变化。
{
"count": "<count_of_observations>",
"sum": "<sum_of_observations>",
"buckets": [ [ <boundary_rule>, "<left_boundary>", "<right_boundary>", "<count_in_bucket>" ], ... ]
}
<boundary_rule> 占位符是介于 0 到 3 之间的整数，具有以下含义
请注意，使用当前实现的桶模式，正桶为“左开”，负桶为“右开”，零桶（左边界为负，右边界为正）为“两边都闭”。
以下端点返回 Prometheus 目标发现的当前状态概述
GET /api/v1/targets
默认情况下，活动目标和已删除的目标都包含在响应中。 如果设置了 keep_dropped_targets 限制，则删除的目标将受其限制。 labels 表示重新标记后出现的标签集。 discoveredLabels 表示在重新标记之前，在服务发现期间检索到的未修改的标签。
$ curl https://127.0.0.1:9090/api/v1/targets
{
"status": "success",
"data": {
"activeTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9090",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"job": "prometheus"
},
"labels": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"scrapePool": "prometheus",
"scrapeUrl": "http://127.0.0.1:9090/metrics",
"globalUrl": "http://example-prometheus:9090/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 0.050688943,
"health": "up",
"scrapeInterval": "1m",
"scrapeTimeout": "10s"
}
],
"droppedTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9100",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"__scrape_interval__": "1m",
"__scrape_timeout__": "10s",
"job": "node"
},
}
]
}
}
state 查询参数允许调用者按活动或已删除的目标进行筛选（例如，state=active、state=dropped、state=any）。请注意，对于筛选掉的目标，仍会返回一个空数组。其他值将被忽略。
$ curl 'https://127.0.0.1:9090/api/v1/targets?state=active'
{
"status": "success",
"data": {
"activeTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9090",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"job": "prometheus"
},
"labels": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"scrapePool": "prometheus",
"scrapeUrl": "http://127.0.0.1:9090/metrics",
"globalUrl": "http://example-prometheus:9090/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 50688943,
"health": "up"
}
],
"droppedTargets": []
}
}
scrapePool 查询参数允许调用者按抓取池名称进行筛选。
$ curl 'https://127.0.0.1:9090/api/v1/targets?scrapePool=node_exporter'
{
"status": "success",
"data": {
"activeTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9091",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"job": "node_exporter"
},
"labels": {
"instance": "127.0.0.1:9091",
"job": "node_exporter"
},
"scrapePool": "node_exporter",
"scrapeUrl": "http://127.0.0.1:9091/metrics",
"globalUrl": "http://example-prometheus:9091/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 50688943,
"health": "up"
}
],
"droppedTargets": []
}
}
/rules API 端点返回当前加载的警报和记录规则的列表。此外，它还会返回每个警报规则的 Prometheus 实例当前触发的活动警报。
由于 /rules 端点是新近的，因此它没有与总体 API v1 相同的稳定性保证。
GET /api/v1/rules
URL 查询参数
type=alert|record：仅返回警报规则（例如 type=alert）或记录规则（例如 type=record）。如果参数不存在或为空，则不进行筛选。rule_name[]=<string>：仅返回具有给定规则名称的规则。如果重复该参数，则返回具有任何给定名称的规则。如果我们筛选掉了某个组的所有规则，则不会返回该组。如果参数不存在或为空，则不进行筛选。rule_group[]=<string>：仅返回具有给定规则组名称的规则。如果重复该参数，则返回具有任何给定规则组名称的规则。如果参数不存在或为空，则不进行筛选。file[]=<string>：仅返回具有给定文件路径的规则。如果重复该参数，则返回具有任何给定文件路径的规则。如果参数不存在或为空，则不进行筛选。exclude_alerts=<bool>：仅返回规则，不返回活动警报。match[]=<label_selector>：仅返回配置的标签满足标签选择器的规则。如果重复该参数，则返回与任何标签选择器集匹配的规则。请注意，匹配是针对每个规则的定义中的标签，而不是模板扩展后的值（对于警报规则）。 可选。group_limit=<number>：group_limit 参数允许您指定单个响应中返回的规则组数量的限制。如果规则组总数超过指定的 group_limit 值，则响应将包含 groupNextToken 属性。您可以在后续请求中使用此 groupNextToken 属性的值，在 group_next_token 参数中分页浏览剩余的规则组。 groupNextToken 属性不会出现在最终响应中，这表示您已检索所有可用的规则组。请注意，如果在分页过程中修改规则组，则无法保证响应的一致性。group_next_token：设置 group_limit 属性时，在先前请求中返回的分页令牌。分页令牌用于迭代分页浏览大量的规则组。要使用 group_next_token 参数，还需要存在 group_limit 参数。如果在您分页浏览规则组时，删除了与下一个令牌一致的规则组，则会返回状态代码 400 的响应。$ curl https://127.0.0.1:9090/api/v1/rules
{
"data": {
"groups": [
{
"rules": [
{
"alerts": [
{
"activeAt": "2018-07-04T20:27:12.60602144+02:00",
"annotations": {
"summary": "High request latency"
},
"labels": {
"alertname": "HighRequestLatency",
"severity": "page"
},
"state": "firing",
"value": "1e+00"
}
],
"annotations": {
"summary": "High request latency"
},
"duration": 600,
"health": "ok",
"labels": {
"severity": "page"
},
"name": "HighRequestLatency",
"query": "job:request_latency_seconds:mean5m{job=\"myjob\"} > 0.5",
"type": "alerting"
},
{
"health": "ok",
"name": "job:http_inprogress_requests:sum",
"query": "sum by (job) (http_inprogress_requests)",
"type": "recording"
}
],
"file": "/rules.yaml",
"interval": 60,
"limit": 0,
"name": "example"
}
]
},
"status": "success"
}
/alerts 端点返回所有活动警报的列表。
由于 /alerts 端点是新近的，因此它没有与总体 API v1 相同的稳定性保证。
GET /api/v1/alerts
$ curl https://127.0.0.1:9090/api/v1/alerts
{
"data": {
"alerts": [
{
"activeAt": "2018-07-04T20:27:12.60602144+02:00",
"annotations": {},
"labels": {
"alertname": "my-alert"
},
"state": "firing",
"value": "1e+00"
}
]
},
"status": "success"
}
以下端点返回有关当前从目标抓取的指标的元数据。这是实验性的，将来可能会发生变化。
GET /api/v1/targets/metadata
URL 查询参数
match_target=<label_selectors>：按其标签集匹配目标的标签选择器。如果留空，则选择所有目标。metric=<string>：要检索元数据的指标名称。如果留空，则检索所有指标元数据。limit=<number>：要匹配的最大目标数。查询结果的 data 部分由包含指标元数据和目标标签集的对象的列表组成。
以下示例返回标签为 job="prometheus" 的前两个目标的 go_goroutines 指标的所有元数据条目。
curl -G https://127.0.0.1:9091/api/v1/targets/metadata \
--data-urlencode 'metric=go_goroutines' \
--data-urlencode 'match_target={job="prometheus"}' \
--data-urlencode 'limit=2'
{
"status": "success",
"data": [
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"type": "gauge",
"help": "Number of goroutines that currently exist.",
"unit": ""
},
{
"target": {
"instance": "127.0.0.1:9091",
"job": "prometheus"
},
"type": "gauge",
"help": "Number of goroutines that currently exist.",
"unit": ""
}
]
}
以下示例返回标签为 instance="127.0.0.1:9090" 的所有目标的所有指标的元数据。
curl -G https://127.0.0.1:9091/api/v1/targets/metadata \
--data-urlencode 'match_target={instance="127.0.0.1:9090"}'
{
"status": "success",
"data": [
// ...
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"metric": "prometheus_treecache_zookeeper_failures_total",
"type": "counter",
"help": "The total number of ZooKeeper failures.",
"unit": ""
},
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"metric": "prometheus_tsdb_reloads_total",
"type": "counter",
"help": "Number of times the database reloaded block data from disk.",
"unit": ""
},
// ...
]
}
它返回有关当前从目标抓取的指标的元数据。但是，它不提供任何目标信息。这被认为是实验性的，将来可能会发生变化。
GET /api/v1/metadata
URL 查询参数
limit=<number>：要返回的最大指标数。limit_per_metric=<number>：每个指标要返回的最大元数据数。metric=<string>：用于筛选元数据的指标名称。如果留空，则检索所有指标元数据。查询结果的 data 部分由一个对象组成，其中每个键是一个指标名称，每个值是唯一元数据对象的列表，这些对象是在所有目标中为该指标名称公开的。
以下示例返回两个指标。请注意，指标 http_requests_total 在列表中有多个对象。至少有一个目标的 HELP 值与其余目标不匹配。
curl -G https://127.0.0.1:9090/api/v1/metadata?limit=2
{
"status": "success",
"data": {
"cortex_ring_tokens": [
{
"type": "gauge",
"help": "Number of tokens in the ring",
"unit": ""
}
],
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
},
{
"type": "counter",
"help": "Amount of HTTP requests",
"unit": ""
}
]
}
}
以下示例仅返回每个指标的一个元数据条目。
curl -G https://127.0.0.1:9090/api/v1/metadata?limit_per_metric=1
{
"status": "success",
"data": {
"cortex_ring_tokens": [
{
"type": "gauge",
"help": "Number of tokens in the ring",
"unit": ""
}
],
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
}
]
}
}
以下示例仅返回指标 http_requests_total 的元数据。
curl -G https://127.0.0.1:9090/api/v1/metadata?metric=http_requests_total
{
"status": "success",
"data": {
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
},
{
"type": "counter",
"help": "Amount of HTTP requests",
"unit": ""
}
]
}
}
以下端点返回 Prometheus Alertmanager 发现的当前状态概述
GET /api/v1/alertmanagers
活动和已删除的 Alertmanager 均包含在响应中。
$ curl https://127.0.0.1:9090/api/v1/alertmanagers
{
"status": "success",
"data": {
"activeAlertmanagers": [
{
"url": "http://127.0.0.1:9090/api/v1/alerts"
}
],
"droppedAlertmanagers": [
{
"url": "http://127.0.0.1:9093/api/v1/alerts"
}
]
}
}
以下状态端点会公开当前的 Prometheus 配置。
以下端点返回当前加载的配置文件
GET /api/v1/status/config
配置以转储的 YAML 文件形式返回。由于 YAML 库的限制，不包含 YAML 注释。
$ curl https://127.0.0.1:9090/api/v1/status/config
{
"status": "success",
"data": {
"yaml": "<content of the loaded config file in YAML>",
}
}
以下端点返回 Prometheus 配置的标志值
GET /api/v1/status/flags
所有值均为结果类型 string。
$ curl https://127.0.0.1:9090/api/v1/status/flags
{
"status": "success",
"data": {
"alertmanager.notification-queue-capacity": "10000",
"alertmanager.timeout": "10s",
"log.level": "info",
"query.lookback-delta": "5m",
"query.max-concurrency": "20",
...
}
}
v2.2 中的新增功能
以下端点返回有关 Prometheus 服务器的各种运行时信息属性
GET /api/v1/status/runtimeinfo
返回的值类型取决于运行时属性的性质。
$ curl https://127.0.0.1:9090/api/v1/status/runtimeinfo
{
"status": "success",
"data": {
"startTime": "2019-11-02T17:23:59.301361365+01:00",
"CWD": "/",
"reloadConfigSuccess": true,
"lastConfigTime": "2019-11-02T17:23:59+01:00",
"timeSeriesCount": 873,
"corruptionCount": 0,
"goroutineCount": 48,
"GOMAXPROCS": 4,
"GOGC": "",
"GODEBUG": "",
"storageRetention": "15d"
}
}
v2.14 中的新增功能
以下端点返回有关 Prometheus 服务器的各种构建信息属性
GET /api/v1/status/buildinfo
所有值均为结果类型 string。
$ curl https://127.0.0.1:9090/api/v1/status/buildinfo
{
"status": "success",
"data": {
"version": "2.13.1",
"revision": "cb7cbad5f9a2823a622aaa668833ca04f50a0ea7",
"branch": "master",
"buildUser": "julius@desktop",
"buildDate": "20191102-16:19:59",
"goVersion": "go1.13.1"
}
}
v2.14 中的新增功能
以下端点返回有关 Prometheus TSDB 的各种基数统计信息
GET /api/v1/status/tsdb
URL 查询参数
limit=<number>：将返回的项目数限制为每组统计数据的给定数字。默认情况下，返回 10 个项目。查询结果的 data 部分由以下内容组成
$ curl https://127.0.0.1:9090/api/v1/status/tsdb
{
"status": "success",
"data": {
"headStats": {
"numSeries": 508,
"chunkCount": 937,
"minTime": 1591516800000,
"maxTime": 1598896800143,
},
"seriesCountByMetricName": [
{
"name": "net_conntrack_dialer_conn_failed_total",
"value": 20
},
{
"name": "prometheus_http_request_duration_seconds_bucket",
"value": 20
}
],
"labelValueCountByLabelName": [
{
"name": "__name__",
"value": 211
},
{
"name": "event",
"value": 3
}
],
"memoryInBytesByLabelName": [
{
"name": "__name__",
"value": 8266
},
{
"name": "instance",
"value": 28
}
],
"seriesCountByLabelValuePair": [
{
"name": "job=prometheus",
"value": 425
},
{
"name": "instance=localhost:9090",
"value": 425
}
]
}
}
v2.15 版本新增
以下端点返回有关 WAL 重放的信息
GET /api/v1/status/walreplay
$ curl https://127.0.0.1:9090/api/v1/status/walreplay
{
"status": "success",
"data": {
"min": 2,
"max": 5,
"current": 40,
"state": "in progress"
}
}
v2.28 版本新增
这些是为高级用户公开数据库功能的 API。 除非设置了 --web.enable-admin-api，否则这些 API 不会启用。
快照会将所有当前数据快照到 TSDB 数据目录下的 snapshots/<datetime>-<rand> 中，并将目录作为响应返回。 它还可以选择跳过仅存在于 head 数据块中的数据快照，这些数据尚未压缩到磁盘。
POST /api/v1/admin/tsdb/snapshot
PUT /api/v1/admin/tsdb/snapshot
URL 查询参数
skip_head=<bool>: 跳过 head 数据块中的数据。 可选。$ curl -XPOST https://127.0.0.1:9090/api/v1/admin/tsdb/snapshot
{
"status": "success",
"data": {
"name": "20171210T211224Z-2be650b6d019eb54"
}
}
快照现在位于 <data-dir>/snapshots/20171210T211224Z-2be650b6d019eb54
v2.1 版本新增，并从 v2.9 版本开始支持 PUT
DeleteSeries 删除时间范围内一系列选定序列的数据。 实际数据仍然存在于磁盘上，并在将来的压缩中进行清理，或者可以通过访问 清理墓碑 端点进行显式清理。
如果成功，将返回 204。
POST /api/v1/admin/tsdb/delete_series
PUT /api/v1/admin/tsdb/delete_series
URL 查询参数
match[]=<series_selector>: 重复的标签匹配器参数，用于选择要删除的序列。 必须提供至少一个 match[] 参数。start=<rfc3339 | unix_timestamp>: 开始时间戳。可选，默认为最小可能时间。end=<rfc3339 | unix_timestamp>: 结束时间戳。可选，默认为最大可能时间。不提及开始和结束时间将清除数据库中匹配序列的所有数据。
示例
$ curl -X POST \
-g 'https://127.0.0.1:9090/api/v1/admin/tsdb/delete_series?match[]=up&match[]=process_start_time_seconds{job="prometheus"}'
v2.1 版本新增，并从 v2.9 版本开始支持 PUT
CleanTombstones 从磁盘删除已删除的数据，并清理现有的墓碑。 这可以在删除序列后用于释放空间。
如果成功，将返回 204。
POST /api/v1/admin/tsdb/clean_tombstones
PUT /api/v1/admin/tsdb/clean_tombstones
此操作不接受参数或请求体。
$ curl -XPOST https://127.0.0.1:9090/api/v1/admin/tsdb/clean_tombstones
v2.1 版本新增，并从 v2.9 版本开始支持 PUT
可以将 Prometheus 配置为 Prometheus 远程写入协议的接收器。 这不被认为是摄取样本的有效方法。 对于特定的低容量用例，请谨慎使用。 它不适合替代通过抓取进行的数据摄取，也不适合将 Prometheus 转变为基于推送的指标收集系统。
通过设置 --web.enable-remote-write-receiver 启用远程写入接收器。 启用后，远程写入接收器端点为 /api/v1/write。 在此处找到更多详细信息。
v2.33 版本新增
可以将 Prometheus 配置为 OTLP 指标协议的接收器。 这不被认为是摄取样本的有效方法。 对于特定的低容量用例，请谨慎使用。 它不适合替代通过抓取进行的数据摄取。
通过设置 --web.enable-otlp-receiver 启用 OTLP 接收器。 启用后，OTLP 接收器端点为 /api/v1/otlp/v1/metrics。
v2.47 版本新增
以下端点提供有关 Prometheus 服务器本身活动的通知信息。 通知在 Web UI 中使用。
这些端点是 实验性的。 它们将来可能会更改。
/api/v1/notifications 端点返回当前所有活动通知的列表。
GET /api/v1/notifications
示例
$ curl https://127.0.0.1:9090/api/v1/notifications
{
"status": "success",
"data": [
{
"text": "Prometheus is shutting down and gracefully stopping all operations.",
"date": "2024-10-07T12:33:08.551376578+02:00",
"active": true
}
]
}
v3.0 版本新增
/api/v1/notifications/live 端点使用 Server-Sent Events 流式传输发生的实时通知。 删除的通知会发送 active: false。 连接到端点时将发送活动通知。
GET /api/v1/notifications/live
示例
$ curl https://127.0.0.1:9090/api/v1/notifications/live
data: {
"status": "success",
"data": [
{
"text": "Prometheus is shutting down and gracefully stopping all operations.",
"date": "2024-10-07T12:33:08.551376578+02:00",
"active": true
}
]
}
注意： 如果已达到最大订阅者数量，则 /notifications/live 端点将返回 204 No Content 响应。 您可以使用标志 --web.max-notifications-subscribers 设置最大侦听器数量，默认为 16。
GET /api/v1/notifications/live
204 No Content
v3.0 版本新增
本文档是 开源 的。 请通过提交问题或拉取请求来帮助改进它。