远程读
更新时间：2025-05-27
接口描述
通过Remote Read读取相应监控实例中的监控数据。
权限说明
使用远程读功能需要先在相应的监控实例信息页面生成Token。
按以下步骤获取对应监控实例Token：
- 进入监控实例详情页（步骤参考 查看实例) 。
- 在监控实例页面下方单击生成Token并复制，如果没有则点击【生成token】。
请求结构
使用Prometheus的query_range查询举例:
Plain Text
1POST {remoteReadUrl}/prometheus/api/v1/query_range HTTP
2Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
3InstanceId: cprom-****
4Content-Type: application/x-www-form-urlencoded
5--data-urlencode 'query=test'
6--data-urlencode 'step=60'
7--data-urlencode 'start=1748328897'
8--data-urlencode 'end=1748329497'请求头域
除公共头域外，特殊头域：
| 头域 | 是否必须 | 说明 |
|---|---|---|
| Content-Type | 是 | 请求参数类型，填写 application/x-www-form-urlencoded |
| Authorization | 是 | 监控实例Token，获取方式参考上面的接口描述 |
| InstanceId | 是 | 监控实例ID |
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| remoteReadUrl | String | 是 | path参数 | 监控实例Remote Read的公网URL, 参考接口描述的示例图 |
| query | String | 是 | URL参数 | 查询的指标名 |
| step | Int | 是 | URL参数 | 查询数据步长，单位:秒 |
| start | Long Int | 是 | URL参数 | 查询数据的开始时间戳，单位:秒 |
| end | Long Int | 是 | URL参数 | 查询数据的结束时间戳，单位:秒 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求是否成功 |
| data | Object | 返回的数据信息, Prometheus 的相关解释参考 Range queries |
| isPartial | Bool | 查询返回是否为部分数据 |
| resultType | String | 查询到的监控数据类型 |
| result | List | 查询到数据结果，包含metric 和values 信息 |
| metric | Map | 查询指标的所有维度 |
| values | List | 查询数据的值，分别为时间戳和具体数值 |
请求示例
Plain Text
1POST http://cprom.gz.baidubce.com/select/prometheus/api/v1/query_range HTTP
2Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
3Content-Type: application/x-www-form-urlencoded
4InstanceId: cprom-****
5--data-urlencode 'query=test'
6--data-urlencode 'step=60'
7--data-urlencode 'start=1748328897'
8--data-urlencode 'end=1748329497'返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 27 May 2025 03:28:11 GMT
4X-Server-Hostname: vmselect-cprom-****-1
5{
6 "status": "success",
7 "isPartial": false,
8 "data": {
9 "resultType": "matrix",
10 "result": [
11 {
12 "metric": {
13 "__name__": "test",
14 "env": "test"
15 },
16 "values": [
17 [
18 1748328897,
19 "10"
20 ]
21 ]
22 }
23 ]
24 }
25}