监控实例接口
更新时间：2026-04-15
查询 CProm 监控实例列表
接口描述
获取 CProm 监控实例列表。支持分页查询，并可按创建时间排序或按实例状态过滤。接口使用 BCE V1 签名鉴权，通过 Authorization 头传递签名串。
请求结构
Http
1GET /v2/instance?pageSize={pageSize}&pageNo={pageNo}&orderBy={orderBy}&order={order}&phase={phase} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageSize | Integer | 否 | Query参数 | 分页查询监控实例列表每页监控实例个数，范围为1-100，缺省值为10 |
| pageNo | Integer | 否 | Query参数 | 分页查询监控实例列表分页页码数，缺省值为1 |
| orderBy | String | 否 | Query参数 | 排序字段，缺省值为createTime，当前只支持createTime。 |
| order | String | 否 | Query参数 | 排序顺序，取值: asc (表示升序), desc (表示降序) |
| phase | String | 否 | Query参数 | 监控实例状态，可选值：Pending, Creating, Failed, Running, Upgrading |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 监控实例列表排序依据字段 |
| order | String | 监控实例列表排序方式：desc倒序，asc升序 |
| pageNo | Integer | 实例列表分页当前页码数 |
| pageSize | Integer | 当前页页监控实例个数 |
| totalCount | Integer | 监控实例总个数 |
| instances | List< MonitorInstance > | 监控实例列表 |
请求示例
Http
1GET /v2/instance?pageSize=10&pageNo=1 HTTP/1.1
2Host: cprom.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Http
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: 27 May 2025 08:23:30 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "orderBy": "createTime",
8 "order": "desc",
9 "pageNo": 1,
10 "pageSize": 10,
11 "totalCount": 2,
12 "instances": [
13 {
14 "instanceId": "cprom-xxxxxx",
15 "instanceName": "cprom-1",
16 "instanceSpec": "advance-v2",
17 "instanceType": "CCE",
18 "retentionPeriod": "30d",
19 "createTime": "2024-05-14T11:06:11Z",
20 "status": {
21 "phase": "Creating",
22 "ready": false,
23 "message": "VMAlert not Ready"
24 },
25 "grafanaId": "grafana-xxxxx",
26 "grafanaName": "test"
27 },
28 {
29 "instanceId": "cprom-xxxxxx",
30 "instanceName": "cprom-1",
31 "instanceSpec": "advance-v2",
32 "instanceType": "CCE",
33 "retentionPeriod": "30d",
34 "createTime": "2024-05-14T11:06:11Z",
35 "status": {
36 "phase": "Running",
37 "ready": true,
38 "message": "all components are ready"
39 },
40 "grafanaId": "grafana-xxxxx",
41 "grafanaName": "test"
42 }
43 ]
44}创建 CProm 监控实例
接口描述
创建一个 CProm 监控实例。可指定实例类型、规格、数据存储时长，并可选择是否在当前地域创建 Grafana。一个地域仅能创建一个 Grafana 实例。接口使用 BCE V1 签名鉴权，通过 Authorization 头传递签名串。
请求结构
Plain Text
1POST /v2/instance HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceSpec": "{instanceSpec}",
7 "instanceName": "{instanceName}",
8 "retentionPeriod": "{retentionPeriod}",
9 "instanceType": "{instanceType}",
10 "needGrafana": needGrafana,
11 "grafanaName": "{grafanaName}",
12 "grafanaAdminPassword": "{grafanaAdminPassword}"
13
14}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceName | String | 是 | Body参数 | 实例名称 |
| instanceType | String | 否 | Body参数 | 监控实例类型，默认为CCE，代表CCE型监控实例，可选值：CCE、BCM |
| instanceSpec | String | 否 | Body参数 | 实例规格类型，默认为基础版"free-v1"，可选值：advance-v1，advance-v2，free-v1 |
| retentionPeriod | String | 否 | Body 参数 | 数据存储时长，默认值为 15d。 |
| needGrafana | Boolean | 否 | Body 参数 | 是否需要创建 Grafana。当前地域无 Grafana 实例时可创建，一个地域仅能创建一个 Grafana 实例。 |
| grafanaName | String | 否 | Body 参数 | 当 needGrafana=true 时提供，Grafana 名称，默认值为 admin。 |
| grafanaAdminPassword | String | 否 | Body 参数 | 当 needGrafana=true 时提供，Grafana 密码长度为 8~32 位，且必须同时包含英文、数字和符号，符号仅限 !@#$%^*()。 |
响应头域
除公共头域外，无其他特殊头域。返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 监控实例ID |
请求示例
Http
1POST /v2/instance HTTP/1.1
2Host: cprom.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "instanceSpec": "free-v1",
8 "instanceName": "test-624",
9 "retentionPeriod": "15d",
10 "instanceType": "CCE",
11 "needGrafana": false
12}响应示例
Http
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: 27 May 2025 08:23:34 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "instanceId": "cprom-xxxxxx"
8}释放 CProm 监控实例
接口描述
释放一个 CProm 监控实例。删除最后一个监控实例时，可通过 deleteGrafana 指定是否同时删除当前地域下的 Grafana 实例。接口使用 BCE V1 签名鉴权，通过 Authorization 头传递签名串。
请求结构
Plain Text
1 DELETE /v2/instance/{instanceId}?deleteGrafana={deleteGrafana} HTTP/1.1
2 Host: cprom.bj.baidubce.com
3 Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path 参数 | CProm 监控实例 ID。 |
| deleteGrafana | Boolean | 否 | Query 参数 | 删除最后一个监控实例时，可选择是否同时删除 Grafana，默认值为 false。 |
响应头域
除公共头域外，无其他特殊头域。返回参数
无
请求示例
Http
1DELETE /v2/instance/cprom-c1tst1cn0be21?deleteGrafana=false HTTP/1.1
2Host: cprom.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Http
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: 27 May 2025 08:23:34 GMT
4Content-Type: application/json;charset=UTF-8生成 CProm 监控实例 Token
接口描述
生成 CProm 监控实例的 Token。若传入 Action=DeleteToken，则表示删除已有 Token。接口使用 BCE V1 签名鉴权，通过 Authorization 头传递签名串。
请求结构
Http
1POST /v2/instance/{instanceId}/token?Action={Action} HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "token": "{token}"
7}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path 参数 | CProm 监控实例 ID。 |
| Action | String | 否 | Query 参数 | 当传值为 DeleteToken 时表示删除 Token；创建 Token 时无需传值。 |
| token | String | 否 | Body 参数 | 当 Action=DeleteToken 时必填。表示待删除的 Token，格式为 Bearer <jwt>；创建 Token 时无需传入。 |
响应头域
除公共头域外，无其他特殊头域。返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| token | String | token值, 如果是删除token 则无返回。 |
请求示例
Http
1POST /v2/instance/cprom-f3pgbuls4d59b/token HTTP/1.1
2Host: cprom.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:33Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Http
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: 27 May 2025 08:23:34 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2UiOiJjcHJvbS1mM3BnYnVsczRkNTliIiwic2VjcmV0TmFtZSI6ImVjYTk3ZTE0OGNiNzRlOTY4M2Q3YjcyNDA4MjlkMWZmIiwixxxxxx"
8}评价此篇文章