监控实例接口
更新时间：2025-05-29
查询CProm监控实例列表
描述
获取CProm监控实例列表。
请求结构
Plain Text
1GET /v2/instance?pageSize=10&pageNo=1 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 > | 监控实例列表 |
请求示例
Plain Text
1GET /v2/instance?pageSize=10&pageNo=1 HTTP/1.1
2Host: cprom.bd.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
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 "orderBy": "createTime",
7 "order": "desc",
8 "pageNo": 1,
9 "pageSize": 10,
10 "totalCount": 2,
11 "instances": [{
12 "instanceId": "cprom-xxxxxx",
13 "instanceName": "cprom-1",
14 "instanceSpec": "advance-v2",
15 "instanceType": "CCE",
16 "retentionPeriod": "30d",
17 "createTime": "2024-05-14T11:06:11Z",
18 "status": {
19 "phase": "Creating",
20 "ready": false,
21 "message": "VMAlert not Ready"
22 },
23 "grafanaId": "grafana-xxxxx",
24 "grafanaName": "test"
25 },{
26 "instanceId": "cprom-xxxxxx",
27 "instanceName": "cprom-1",
28 "instanceSpec": "advance-v2",
29 "instanceType": "CCE",
30 "retentionPeriod": "30d",
31 "createTime": "2024-05-14T11:06:11Z",
32 "status": {
33 "phase": "Running",
34 "ready": true,
35 "message": "all components are ready"
36 },
37 "grafanaId": "grafana-xxxxx",
38 "grafanaName": "test"
39 }]
40}
41}创建CProm监控实例
描述
创建一个CProm监控实例。
请求结构
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参数 | 数据存储时长，默认为15天 |
| needGrafana | Boolen | 否 | Body参数 | 是否需要创建Grafana，该地域无Grafana实例时需要创建，一个地域仅能创建一个Grafana实例 |
| grafanaName | Sring | 否 | Body参数 | needMonitorGrafana为true时提供，Grafana名称，默认为admin |
| grafanaAdminPassword | Sring | 否 | Body参数 | needMonitorGrafana为true时提供，Grafana密码8～32位字符，英文、数字和符号必须同时存在，符号仅限!@#$%^*() |
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 监控实例ID |
请求示例
Plain Text
1POST /v2/instance HTTP/1.1
2Host: cprom.bj.baidubce.com
3ContentType: 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}返回示例
Plain Text
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 "instanceId": "cprom-xxxxxx"
7}释放CProm监控实例
描述
释放一个CProm监控实例。
请求结构
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 | Boolen | 否 | Query参数 | 在删除最后一个监控实例时，可以选择是否删除Grafana，默认为false不删除 |
返回参数
无
请求示例
Plain Text
1DELETE /v2/instance/cprom-c1tst1cn0be21?deleteGrafana=false HTTP/1.1
2Host: cprom.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1200 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
请求结构
Plain Text
1POST /v2/instance/{instanceId}/token HTTP/1.1
2Host: cprom.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | path | Cprom监控实例ID |
| Action | String | 否 | Query参数 | 当传值为DeleteToken时表示删除token，创建时无需传值。 |
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| token | String | token值, 如果是删除token 则无返回。 |
请求示例
Plain Text
1POST /v2/instance/cprom-f3pgbuls4d59b/token HTTP/1.1
2Host: cprom.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2025-05-27T08:23:33Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1200 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 "token": "BearereyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lc3BhY2UiOiJjcHJvbS1mM3BnYnVsczRkNTliIiwic2VjcmV0TmFtZSI6ImVjYTk3ZTE0OGNiNzRlOTY4M2Q3YjcyNDA4MjlkMWZmIiwixxxxxx"
7
8}