采集配置相关接口

更新时间：2026-02-03

创建自定义采集任务

描述

创建CProm监控实例的自定义采集任务。

请求结构

Plain Text

1POST /v2/scrape_job?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{
5     "config": "{config}"
6}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID，参考查询CCE集群接入CProm状态
config	String	是	Body参数	抓取任务配置，示例值见请求示例

返回参数

参数名称	类型	描述
scrapeJobId	String	采集任务ID

请求示例

Plain Text

1POST /v2/scrape_job?instanceId=cprom_xxx&agentId=xxxx  HTTP/1.1
2Host: cprom.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5{
6    "config": "job_name: 'kubernetes-pods'\nkubernetes_sd_configs:\n  - role: pod\nrelabel_configs:\n- source_labels: [__meta_kubernetes_service_annotation_prometheus_io_scheme]\n  action: replace\n  target_label: __scheme__\n  regex: (https?)\n- source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_scrape]\n  action: keep\n  regex: true\n- source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_path]\n  action: replace\n  target_label: __metrics_path__\n  regex: (.+)\n- source_labels: [__address__, __meta_kubernetes_pod_annotation_prometheus_io_port]\n  action: replace\n  regex: ([^:]+)(?::\\d+)?;(\\d+)\n  replacement: $1:$2\n  target_label: __address__\n- action: labelmap\n  regex: __meta_kubernetes_pod_label_(.+)\n- action: labeldrop\n  regex: (.+)_revision_hash|(.+)_template_generation\n- source_labels: [__meta_kubernetes_namespace]\n  action: replace\n  target_label: namespace_name\n- source_labels: [__meta_kubernetes_pod_name]\n  action: replace\n  target_label: pod_name\n"
7}

body 的格式化效果

Plain Text

1{
2    "config": `job_name: 'kubernetes-pods'
3kubernetes_sd_configs:
4  - role: pod
5relabel_configs:
6- source_labels: [__meta_kubernetes_service_annotation_prometheus_io_scheme]
7  action: replace
8  target_label: __scheme__
9  regex: (https?)
10- source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_scrape]
11  action: keep
12  regex: true
13- source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_path]
14  action: replace
15  target_label: __metrics_path__
16  regex: (.+)
17- source_labels: [__meta_kubernetes_pod_label_app]
18  action: drop
19  regex: kube-state-metrics|node-exporter|dcgm-exporter|training-operator
20- source_labels: [__address__, __meta_kubernetes_pod_annotation_prometheus_io_port]
21  action: replace
22  regex: ([^:]+)(?::\d+)?;(\d+)
23  replacement: $1:$2
24  target_label: __address__
25- action: labelmap
26  regex: __meta_kubernetes_pod_label_(.+)
27- action: labeldrop
28  regex: (.+)_revision_hash|(.+)_template_generation
29`
30}

返回示例

Plain Text

1HTTP/1.1200 OK     
2x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
3Date: Fri,20 May 2025 08:23:14 GMT    
4Content Type: application/json;charset=UTF-8
5{
6    "scrapeJobId":"job-xxxx"  
7
8}

删除自定义采集任务

描述

删除CProm监控实例的自定义采集任务。

请求结构

Plain Text

1DELETE /v2/scrape_job/{scrapeJobId}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
scrapeJobId	String	是	Path参数	采集任务ID
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{}

创建Service Monitor

描述

创建CProm监控实例的 Service Monitor 采集配置。

请求结构

Plain Text

1POST /v2/service_monitor?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{ServiceMonitor}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
apiVersion	String	是	Body参数	固定值：monitoring.coreos.com/v1
kind	String	是	Body参数	固定值：ServiceMonitor
metadata	ObjectMeta	是	Body参数	ServiceMonitor的元数据, 其中namespace可固定填default, 不会在用户集群创建出资源。
spec	ServiceMonitorSpec	是	Body参数	采集规则

ObjectMeta

字段	类型	是否必需	描述
name	String	是	资源名称
namespace	String	是	命名空间

ServiceMonitorSpec

字段	类型	是否必需	描述
endpoints	List< ServiceMonitorEndpoint >	是	采集端点配置列表
namespaceSelector	NamespaceSelector	是	Service 所在命名空间选择器
selector	LabelSelector	是	Service 标签选择器

ServiceMonitorEndpoint：

字段	类型	是否必需	描述
interval	String	否	采集间隔，如：15s，可不传，默认为 15s
path	String	否	采集路径，如：/metrics 可不传，默认为 /metrics
port	String	是	对应 Service 的 port name，注意不是端口号

NamespaceSelector：

字段	类型	是否必需	描述
matchNames	List< String >	是	命名空间列表

LabelSelector：

字段	类型	是否必需	描述
matchLabels	Map<String,String>	是	标签键值对，如{"k8s-app":"metrics-server"}

返回参数

参数名称	类型	描述
serviceMonitorName	String	Service Monitor名称

请求示例

Plain Text

1POST /v2/service_monitor?instanceId=cprom_xxx&agentId=agent-xxx  HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: bce-auth-v1/xxxx
4{
5  "apiVersion": "monitoring.coreos.com/v1",
6  "kind": "ServiceMonitor",
7  "metadata": {
8    "name": "example",
9    "namespace": "default"
10  },
11  "spec": {
12    "endpoints": [
13      {
14        "interval": "15s",
15        "path": "/metrics",
16        "port": "test"
17      }
18    ],
19    "namespaceSelector": {
20      "matchNames": [
21        "monitoring"
22      ]
23    },
24    "selector": {
25      "matchLabels": {
26        "app": "monitor"
27      }
28    }
29  }
30}

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "serviceMonitorName": "example"
5}

查询Service Monitor列表

描述

查询CProm监控实例的 Service Monitor 列表。

请求结构

Plain Text

1GET /v2/service_monitor?instanceId={instanceId}&agentId={agentId}&pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&orderBy={orderBy}&order={order} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
pageNo	Integer	否	Query参数	分页页码，缺省值为1
pageSize	Integer	否	Query参数	每页数量，范围为1-100，缺省值为10
keywordType	String	否	Query参数	筛选条件类型，支持：serviceMonitorName
keyword	String	否	Query参数	筛选关键字
orderBy	String	否	Query参数	排序字段，仅支持：createTime，缺省值为createTime
order	String	否	Query参数	排序方式：desc/asc，缺省值为desc

返回参数

参数名称	类型	描述
orderBy	String	排序字段
order	String	排序方式
keywordType	String	筛选条件类型
keyword	String	筛选关键字
pageNo	Integer	当前页码
pageSize	Integer	每页数量
totalCount	Integer	总数量
status	String	Service Monitor 服务状态：running/terminated
items	List< ServiceMonitorItem >	Service Monitor 列表

ServiceMonitorItem

字段	类型	描述
serviceMonitorName	String	Service Monitor名称
namespace	String	Service Monitor命名空间
enable	String	是否启用：true/false
createTime	String	创建时间
endpoints	List< Endpoint >	端点信息

Endpoint

字段	类型	描述
port	String	端口名称
path	String	采集路径
interval	String	采集间隔
matchedTargetCount	Integer	匹配的 target 数量

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "orderBy": "createTime",
5  "order": "desc",
6  "keywordType": "serviceMonitorName",
7  "keyword": "example",
8  "pageNo": 1,
9  "pageSize": 10,
10  "totalCount": 1,
11  "status": "running",
12  "items": [
13    {
14      "serviceMonitorName": "example",
15      "namespace": "default",
16      "enable": "true",
17      "createTime": "2025-05-20T08:23:14Z",
18      "endpoints": [
19        {
20          "port": "http-metrics",
21          "path": "/metrics",
22          "interval": "15s",
23          "matchedTargetCount": 2
24        }
25      ]
26    }
27  ]
28}

查看Service Monitor详情

描述

查看CProm监控实例的 Service Monitor 详情。

请求结构

Plain Text

1GET /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

参数名称	类型	描述
apiVersion	String	是
kind	String	固定值：ServiceMonitor
metadata	ObjectMeta	ServiceMonitor的元数据
spec	ServiceMonitorSpec	采集规则

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "apiVersion": "monitoring.coreos.com/v1",
5  "kind": "ServiceMonitor",
6  "metadata": {
7    "name": "example",
8    "namespace": "default"
9  },
10  "spec": {
11    "endpoints": [
12      {
13        "interval": "15s",
14        "path": "/metrics",
15        "port": "test"
16      }
17    ],
18    "namespaceSelector": {
19      "matchNames": [
20        "monitoring"
21      ]
22    },
23    "selector": {
24      "matchLabels": {
25        "app": "monitor"
26      }
27    }
28  }
29}

更新Service Monitor

描述

更新CProm监控实例的 Service Monitor 配置及启用状态。

请求结构

Plain Text

1PUT /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{
5  "enable": "true|false",
6  "serviceMonitor": {ServiceMonitor}
7}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
enable	String	是	Body参数	是否启用：true/false
serviceMonitor	ServiceMonitor	是	Body参数	ServiceMonitor对象

ServiceMonitor

参数名称	类型	是否必需	参数位置	描述
apiVersion	String	是	Body参数	固定值：monitoring.coreos.com/v1
kind	String	是	Body参数	固定值：ServiceMonitor
metadata	ObjectMeta	是	Body参数	ServiceMonitor的元数据, 不支持修改。
spec	ServiceMonitorSpec	是	Body参数	采集规则

返回参数

无

删除Service Monitor

描述

删除CProm监控实例的 Service Monitor。

请求结构

Plain Text

1DELETE /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

启停Service Monitor服务

描述

对指定 CProm 实例下的 Service Monitor 服务进行启停操作, 启动会启用实例下所有的Service Monitor，停用会禁用实例下所有的Service Monitor。

请求结构

Plain Text

1PUT /v2/service_monitor?action={action}&instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
action	String	是	Query参数	启停动作：start/stop
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

创建Pod Monitor

描述

创建CProm监控实例的 Pod Monitor 采集配置。

请求结构

Plain Text

1POST /v2/pod_monitor?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{PodMonitor}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
apiVersion	String	是	Body参数	固定值：monitoring.coreos.com/v1
kind	String	是	Body参数	固定值：PodMonitor
metadata	ObjectMeta	是	Body参数	元数据
spec	PodMonitorSpec	是	Body参数	采集规则

PodMonitorSpec

字段	类型	是否必需	描述
namespaceSelector	NamespaceSelector	是	监控范围命名空间选择器
podMetricsEndpoints	List< PodMetricsEndpoint >	是	采集端点配置列表
selector	LabelSelector	是	Pod 标签选择器

说明

ObjectMeta、NamespaceSelector、LabelSelector 结构体定义与“创建Service Monitor”章节一致。

PodMetricsEndpoint

字段	类型	是否必需	描述
interval	String	否	采集间隔，如：15s，可不传，默认为 15s
path	String	否	采集路径，如：/metrics 可不传，默认为 /metrics
port	String	是	对应 Pod 的 port name，注意不是端口号

说明

本接口文档仅暴露 PodMonitor 的必要字段（见“请求示例”），系统内部字段会自动处理并隐藏。

返回参数

参数名称	类型	描述
podMonitorName	String	Pod Monitor名称

请求示例

Plain Text

1POST /v2/pod_monitor?instanceId=cprom_xxx&agentId=agent-xxx  HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: bce-auth-v1/xxxx
4apiVersion: monitoring.coreos.com/v1

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "serviceMonitorName": "example"
5}

查询Service Monitor列表

描述

查询CProm监控实例的 Service Monitor 列表。

请求结构

Plain Text

1GET /v2/service_monitor?instanceId={instanceId}&agentId={agentId}&pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&orderBy={orderBy}&order={order} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
pageNo	Integer	否	Query参数	分页页码，缺省值为1
pageSize	Integer	否	Query参数	每页数量，范围为1-100，缺省值为10
keywordType	String	否	Query参数	筛选条件类型，支持：serviceMonitorName
keyword	String	否	Query参数	筛选关键字
orderBy	String	否	Query参数	排序字段，仅支持：createTime，缺省值为createTime
order	String	否	Query参数	排序方式：desc/asc，缺省值为desc

返回参数

参数名称	类型	描述
orderBy	String	排序字段
order	String	排序方式
keywordType	String	筛选条件类型
keyword	String	筛选关键字
pageNo	Integer	当前页码
pageSize	Integer	每页数量
totalCount	Integer	总数量
status	String	Service Monitor 服务状态：running/terminated
items	List< ServiceMonitorItem >	Service Monitor 列表

ServiceMonitorItem

字段	类型	描述
serviceMonitorName	String	Service Monitor名称
namespace	String	Service Monitor命名空间
enable	String	是否启用：true/false
createTime	String	创建时间
endpoints	List< Endpoint >	端点信息

Endpoint

字段	类型	描述
port	String	端口名称
path	String	采集路径
interval	String	采集间隔
matchedTargetCount	Integer	匹配的 target 数量

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "orderBy": "createTime",
5  "order": "desc",
6  "keywordType": "serviceMonitorName",
7  "keyword": "example",
8  "pageNo": 1,
9  "pageSize": 10,
10  "totalCount": 1,
11  "status": "running",
12  "items": [
13    {
14      "serviceMonitorName": "example",
15      "namespace": "default",
16      "enable": "true",
17      "createTime": "2025-05-20T08:23:14Z",
18      "endpoints": [
19        {
20          "port": "http-metrics",
21          "path": "/metrics",
22          "interval": "15s",
23          "matchedTargetCount": 2
24        }
25      ]
26    }
27  ]
28}

查看Service Monitor详情

描述

查看CProm监控实例的 Service Monitor 详情。

请求结构

Plain Text

1GET /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

参数名称	类型	描述
apiVersion	String	是
kind	String	固定值：ServiceMonitor
metadata	ObjectMeta	ServiceMonitor的元数据
spec	ServiceMonitorSpec	采集规则

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "apiVersion": "monitoring.coreos.com/v1",
5  "kind": "ServiceMonitor",
6  "metadata": {
7    "name": "example",
8    "namespace": "default"
9  },
10  "spec": {
11    "endpoints": [
12      {
13        "interval": "15s",
14        "path": "/metrics",
15        "port": "test"
16      }
17    ],
18    "namespaceSelector": {
19      "matchNames": [
20        "monitoring"
21      ]
22    },
23    "selector": {
24      "matchLabels": {
25        "app": "monitor"
26      }
27    }
28  }
29}

更新Service Monitor

描述

更新CProm监控实例的 Service Monitor 配置及启用状态。

请求结构

Plain Text

1PUT /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{
5  "enable": "true|false",
6  "serviceMonitor": {ServiceMonitor}
7}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
enable	String	是	Body参数	是否启用：true/false
serviceMonitor	ServiceMonitor	是	Body参数	ServiceMonitor对象

ServiceMonitor

参数名称	类型	是否必需	参数位置	描述
apiVersion	String	是	Body参数	固定值：monitoring.coreos.com/v1
kind	String	是	Body参数	固定值：ServiceMonitor
metadata	ObjectMeta	是	Body参数	ServiceMonitor的元数据, 不支持修改。
spec	ServiceMonitorSpec	是	Body参数	采集规则

返回参数

无

删除Service Monitor

描述

删除CProm监控实例的 Service Monitor。

请求结构

Plain Text

1DELETE /v2/service_monitor/{serviceMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
serviceMonitorName	String	是	Path参数	Service Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

启停Service Monitor服务

描述

对指定 CProm 实例下的 Service Monitor 服务进行启停操作, 启动会启用实例下所有的Service Monitor，停用会禁用实例下所有的Service Monitor。

请求结构

Plain Text

1PUT /v2/service_monitor?action={action}&instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
action	String	是	Query参数	启停动作：start/stop
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

创建Pod Monitor

描述

创建CProm监控实例的 Pod Monitor 采集配置。

请求结构

Plain Text

1POST /v2/pod_monitor?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{PodMonitor}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
apiVersion	String	是	Body参数	固定值：monitoring.coreos.com/v1
kind	String	是	Body参数	固定值：PodMonitor
metadata	ObjectMeta	是	Body参数	元数据
spec	PodMonitorSpec	是	Body参数	采集规则

PodMonitorSpec

字段	类型	是否必需	描述
namespaceSelector	NamespaceSelector	是	监控范围命名空间选择器
podMetricsEndpoints	List< PodMetricsEndpoint >	是	采集端点配置列表
selector	LabelSelector	是	Pod 标签选择器

说明

ObjectMeta、NamespaceSelector、LabelSelector 结构体定义与“创建Service Monitor”章节一致。

PodMetricsEndpoint

字段	类型	是否必需	描述
interval	String	否	采集间隔，如：15s，可不传，默认为 15s
path	String	否	采集路径，如：/metrics 可不传，默认为 /metrics
port	String	是	对应 Pod 的 port name，注意不是端口号

说明

本接口文档仅暴露 PodMonitor 的必要字段（见“请求示例”），系统内部字段会自动处理并隐藏。

返回参数

参数名称	类型	描述
podMonitorName	String	Pod Monitor名称

请求示例

Plain Text

1POST /v2/pod_monitor?instanceId=cprom_xxx&agentId=agent-xxx  HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: bce-auth-v1/xxxx
4{
5  "apiVersion": "monitoring.coreos.com/v1",
6  "kind": "PodMonitor",
7  "metadata": {
8    "name": "podmonitor-test",
9    "namespace": "monitoring"
10  },
11  "spec": {
12    "namespaceSelector": {
13      "matchNames": [
14        "monitoring"
15      ]
16    },
17    "podMetricsEndpoints": [
18      {
19        "interval": "15s",
20        "port": "http"
21      }
22    ],
23    "selector": {
24      "matchLabels": {
25        "app": "monitor"
26      }
27    }
28  }
29}

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "podMonitorName": "podmonitor-test"
5}

查询Pod Monitor列表

描述

查询CProm监控实例的 Pod Monitor 列表。

请求结构

Plain Text

1GET /v2/pod_monitor?instanceId={instanceId}&agentId={agentId}&pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&orderBy={orderBy}&order={order} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
pageNo	Integer	否	Query参数	分页页码，缺省值为1
pageSize	Integer	否	Query参数	每页数量，范围为1-100，缺省值为10
keywordType	String	否	Query参数	筛选条件类型，支持：podMonitorName
keyword	String	否	Query参数	筛选关键字
orderBy	String	否	Query参数	排序字段，仅支持：createTime，缺省值为createTime
order	String	否	Query参数	排序方式：desc/asc，缺省值为desc

返回参数

参数名称	类型	描述
orderBy	String	排序字段
order	String	排序方式
keywordType	String	筛选条件类型
keyword	String	筛选关键字
pageNo	Integer	当前页码
pageSize	Integer	每页数量
totalCount	Integer	总数量
status	String	Pod Monitor 服务状态：running/terminated
items	List< PodMonitorItem >	Pod Monitor 列表

PodMonitorItem：

字段	类型	描述
podMonitorName	String	Pod Monitor名称
namespace	String	Pod Monitor命名空间
enable	String	是否启用：true/false
createTime	String	创建时间
endpoints	List< Endpoint >	端点信息

Endpoint：

字段	类型	描述
port	String	端口名称
path	String	采集路径
interval	String	采集间隔
matchedTargetCount	Integer	匹配的 target 数量

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "orderBy": "createTime",
5  "order": "desc",
6  "keywordType": "podMonitorName",
7  "keyword": "podmonitor-test",
8  "pageNo": 1,
9  "pageSize": 10,
10  "totalCount": 1,
11  "status": "running",
12  "items": [
13    {
14      "podMonitorName": "podmonitor-test",
15      "namespace": "monitoring",
16      "enable": "true",
17      "createTime": "2025-05-20T08:23:14Z",
18      "endpoints": [
19        {
20          "port": "http",
21          "path": "/metrics",
22          "interval": "15s",
23          "matchedTargetCount": 2
24        }
25      ]
26    }
27  ]
28}

查看Pod Monitor详情

描述

查看CProm监控实例的 Pod Monitor 详情。

请求结构

Plain Text

1GET /v2/pod_monitor/{podMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
podMonitorName	String	是	Path参数	Pod Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

参数名称	类型	描述
apiVersion	String	是
kind	String	固定值：ServiceMonitor
metadata	ObjectMeta	PodMonitor的元数据
spec	PodMonitorSpec	采集规则

返回示例

Plain Text

1HTTP/1.1200 OK
2Content Type: application/json;charset=UTF-8
3{
4  "apiVersion": "monitoring.coreos.com/v1",
5  "kind": "PodMonitor",
6  "metadata": {
7    "name": "podmonitor-test",
8    "namespace": "monitoring"
9  },
10  "spec": {
11    "namespaceSelector": {
12      "matchNames": [
13        "monitoring"
14      ]
15    },
16    "podMetricsEndpoints": [
17      {
18        "interval": "15s",
19        "port": "http"
20      }
21    ],
22    "selector": {
23      "matchLabels": {
24        "app": "monitor"
25      }
26    }
27  }
28}

更新Pod Monitor

描述

更新CProm监控实例的 Pod Monitor 配置及启用状态。

请求结构

Plain Text

1PUT /v2/pod_monitor/{podMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4{
5  "enable": "true|false",
6  "podMonitor": {PodMonitor}
7}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
podMonitorName	String	是	Path参数	Pod Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID
enable	String	是	Body参数	是否启用：true/false
podMonitor	PodMonitor	是	Body参数	PodMonitor对象（字段见“创建Pod Monitor”）

PodMonitor

字段	类型	是否必需	描述
apiVersion	String	是	固定值：monitoring.coreos.com/v1
kind	String	是	固定值：PodMonitor
metadata	ObjectMeta	是	元数据
spec	PodMonitorSpec	是	采集规则

说明

Pod Monitor 名称与命名空间不支持修改。

返回参数

无

删除Pod Monitor

描述

删除CProm监控实例的 Pod Monitor。

请求结构

Plain Text

1DELETE /v2/pod_monitor/{podMonitorName}?instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
podMonitorName	String	是	Path参数	Pod Monitor名称
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

启停Pod Monitor服务

描述

对指定 CProm 实例下的 Pod Monitor 服务进行启停操作, 启动会启用实例下所有的Pod Monitor，停用会禁用实例下所有的Pod Monitor。

请求结构

Plain Text

1PUT /v2/pod_monitor_service?action={action}&instanceId={instanceId}&agentId={agentId} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
action	String	是	Query参数	启停动作：start/stop
instanceId	String	是	Query参数	Cprom监控实例ID
agentId	String	是	Query参数	Agent ID

返回参数

无

附录

关联云产品接口

百度智能云

Prometheus监控服务 CProm

Prometheus监控服务 CProm

采集配置相关接口

创建自定义采集任务

删除自定义采集任务

创建Service Monitor

ObjectMeta

ServiceMonitorSpec

ServiceMonitorEndpoint：

NamespaceSelector：

LabelSelector：

查询Service Monitor列表

查看Service Monitor详情

更新Service Monitor

删除Service Monitor

启停Service Monitor服务

创建Pod Monitor

PodMonitorSpec

PodMetricsEndpoint

查询Service Monitor列表

查看Service Monitor详情

更新Service Monitor

删除Service Monitor

启停Service Monitor服务

创建Pod Monitor

PodMonitorSpec

PodMetricsEndpoint

查询Pod Monitor列表

查看Pod Monitor详情

更新Pod Monitor

PodMonitor

删除Pod Monitor

启停Pod Monitor服务