远程写
更新时间:2025-05-27
远程写
接口描述
通过Remote Write将数据写入相应的监控实例中。
权限说明
按以下步骤获取对应监控实例Token:
- 进入监控实例详情页(步骤参考 查看实例) 。
- 在监控实例页面下方单击生成Token并复制,如果没有则点击【生成token】。
注意事项
请求结构
Plain Text
1POST {remoteWriteUrl}/prometheus/api/v1/write HTTPS
2Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
3InstanceId: cprom-****
4Content-Type: application/x-protobuf
5Content-Encoding: snappy
请求头域
除公共头域外,特殊头域:
头域 | 是否必须 | 说明 |
---|---|---|
Content-Type | 是 | 请求参数类型,填写 application/x-protobuf |
Content-Encoding | 是 | 数据编码格式,填写 snappy |
InstanceId | 是 | 监控实例ID |
Authorization | 是 | 监控实例Token |
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
remoteWriteUrl | String | 是 | path参数 | 监控实例Remote Write的公网URL, 参考接口描述的示例图 |
数据写入body中并采用Prometheus定义的格式,具体参数格式参考:远程写数据格式
返回头域
除公共头域外,无其它特殊头域。
返回参数
返回状态码为204表示无内容,如有访问错误返回其他状态码,请根据对应状态码含义处理。
请求示例
Plain Text
1POST https://cprom.gz.baidubce.com/test/insert/prometheus/api/v1/write
2Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
3InstanceId: cprom-****
4Content-Type: application/x-protobuf
5Content-Encoding: snappy
返回示例
Plain Text
1HTTPS 204 OK
2Date: Wed, 27 May 2025 03:28:11 GMT
3X-Server-Hostname: vminsert-cprom-****-****-tdh3