远程写
更新时间:2026-04-15
远程写
接口描述
通过 Remote Write 将数据写入相应的监控实例中。
权限说明
按以下步骤获取对应监控实例Token:
- 进入监控实例详情页(步骤参考 查看实例) 。
- 在监控实例页面下方单击生成Token并复制,如果没有则点击【生成token】。

注意事项
- 调用前,请确认监控实例处于
Running状态。 - 请求体需采用 Prometheus Remote Write 的 protobuf 结构编码,并使用
snappy压缩。
请求
请求结构
Http
1POST {remoteWriteUrl}/prometheus/api/v1/write HTTPS
2Authorization: Bearer {token}
3InstanceId: {instanceId}
4Content-Type: application/x-protobuf
5Content-Encoding: snappy
6
7<snappy-compressed protobuf payload>
请求头域
除公共头域外,特殊头域:
| 头域 | 是否必须 | 说明 |
|---|---|---|
| Content-Type | 是 | 请求参数类型,填写 application/x-protobuf |
| Content-Encoding | 是 | 数据编码格式,填写 snappy |
| InstanceId | 是 | 监控实例 ID |
| Authorization | 是 | 监控实例 Token,格式为 Bearer {token} |
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| remoteWriteUrl | String | 是 | Path | 监控实例 Remote Write 的公网接入地址,与固定路径 /prometheus/api/v1/write 组合为完整请求 URL |
| body | Binary | 是 | Body | Prometheus Remote Write 的 protobuf 二进制数据,需使用 snappy 压缩,具体格式参考: 远程写数据格式 |
响应
返回头域
除公共头域外,无其它特殊头域。
响应参数
调用成功时返回状态码 204,响应体为空。
调用失败时返回其他状态码,请根据对应状态码及错误信息处理。
示例
请求示例
Http
1POST https://cprom.gz.baidubce.com/insert/prometheus/api/v1/write
2Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2Ui****HJvbS03bjU4NjN3MjEiLCJzZWNyZXROYW1lIjoiYWdlbnQtN2ZzNTNrN2MxIiwiZXhwIjoxNzE4MzM1MTA3LCJpc3MiOiJjcHJvbSJ9.5JJX_gl76aLagz8jpq7PT5AI34jdlC36IwCaYr46qWo
3InstanceId: cprom-y60ubfbvnooh2
4Content-Type: application/x-protobuf
5Content-Encoding: snappy
请求体为经 snappy 压缩后的 Prometheus Remote Write protobuf 二进制数据。本示例对应的原始指标内容为 demo_remote_write_metric_total{source="manual",env="test"} 1。
响应示例
Http
1HTTP/1.1 204 No Content
2Date: Tue, 27 May 2025 03:28:11 GMT
3X-Server-Hostname: vminsert-cprom-****-****-tdh3
评价此篇文章
