API 概览

支持的 API

Prometheus 监控服务所支持的 API 在参数输入与响应数据格式上与开源 Prometheus 保持完全兼容，未在本文档中明确列出的 API 默认均不受支持。以下所有 API 均基于 HTTP 协议实现：

API	说明	使用方式
/api/v1/query	查询某一时刻的数据	推荐使用 Grafana，可使用 HTTP 相关工具
/api/v1/query_range	查询时间范围类的数据	推荐使用 Grafana，可使用 HTTP 相关工具
/api/v1/series	查询 series	推荐使用 Grafana，可使用 HTTP 相关工具
/api/v1/labels	查询标签名	推荐使用 Grafana，可使用 HTTP 相关工具
/api/v1/label/{label_name}/values	查询标签名多对应的值	推荐使用 Grafana，可使用 HTTP 相关工具

认证方法

以上API 均需要认证，目前只支持以下认证方式。

Bearer Token

Bearer Token 随着实例创建而生成，进入控制台云监控控制台-Prometheus监控，点击Prometheus实例详情，可获取Token 。

API 响应及相关状态码

数据上报请求无固定的响应格式，程序只需关注状态码即可。建议对错误响应记录完整响应体，便于问题排查。

查询请求的响应格式为 JSON，基本结构如下：

{
  "status": "success" | "error",
  "data": <data>,

  // 当 status 状态为 error 时，下面的数据将被返回。
  "errorType": "<string>",
  "error": "<string>",

  // 当执行请求时有警告信息时，该字段将被填充返回。
  "warnings": ["<string>"]
}

相关状态码说明：

状态码	请求类型	概述
400	查询 / 数据上报	请求参数错误 / 数据上报时如果 series 达到上限可能会出现此错误
401	查询 / 数据上报	认证失败
404	查询 / 数据上报	API 不存在
422	查询	查询请求的表达式无法执行(RFC4918)
429	数据上报	数据上报时 samples 速率达到上限（对于基础版，如果自监控上体现出余量还较多，Agent 会自动重新上报数据，这种情况理论上不会丢失数据，平均下来不超过限制）
500	查询 / 数据上报	内部错误，频繁出现请联系我们
503	查询 / 数据上报	服务在启动、重建或升级中 / 查询请求被中止或者超时

文档导读

上一篇：API 使用指南

下一篇：监控数据查询

纯净模式常规模式

纯净模式

点击可全屏预览文档内容