远程读
更新时间：2024-05-29
远程读
接口描述
通过Remote Read读取相应监控实例中的监控数据。
权限说明
使用远程读功能需要先在相应的监控实例信息页面生成Token。
按以下步骤获取对应监控实例Token：
- 登录云管理控制台，选择“产品服务>云原生>Prometheus监控服务”。
- 单击对应监控实例跳转对应的实例信息页。
- 在监控实例页面下方单击生成Token并复制。
请求结构
使用Prometheus的query_range查询举例:
POST {Remote Read}/prometheus/api/v1/query_range HTTP
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
InstanceId: cprom-****
Content-Type: application/x-www-form-urlencoded
--data-urlencode 'query=test'
--data-urlencode 'step=60'
--data-urlencode 'start=1655827200'
--data-urlencode 'end=1655913540'请求头域
除公共头域外，特殊头域：
| 头域 | 是否必须 | 说明 |
|---|---|---|
| Content-Type | 是 | 请求参数类型，填写 application/x-www-form-urlencoded |
| Authorization | 是 | 相应监控实例信息页面生成的Token |
| InstanceId | 是 | 相应监控实例信息的监控实例ID |
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| Remote Read | String | 是 | path参数 | 使用对应监控实例远程读公网地址 |
| query | String | 是 | URL参数 | 查询的指标名 |
| step | Int | 是 | URL参数 | 查询数据步长 |
| start | Unix_timestamp | 是 | URL参数 | 查询数据的开始时间 |
| end | Unix_timestamp | 是 | URL参数 | 查询数据的结束时间 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求是否成功 |
| data | Object | 返回的数据信息 |
| isPartial | Bool | 查询返回是否为部分数据 |
| resultType | String | 查询到的监控数据类型 |
| result | List | 查询到数据结果 |
| metric | Map | 查询指标的所有维度 |
| values | List | 查询数据的值，分别为时间戳和具体数值 |
请求示例
POST http://cprom.gz.baidubce.com/select/prometheus/api/v1/query_range HTTP
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
Content-Type: application/x-www-form-urlencoded
InstanceId: cprom-****
--data-urlencode 'query=test'
--data-urlencode 'step=60'
--data-urlencode 'start=1655827200'
--data-urlencode 'end=1655913540'返回示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
X-Server-Hostname: vmselect-cprom-****-1
{
"status": "success",
"isPartial": false,
"data": {
"resultType": "matrix",
"result": [
{
"metric": {
"__name__": "test",
"env": "test"
},
"values": [
[
1655827200,
"10"
]
]
}
]
}
}