批量查询监控数据接口V2
更新时间：2025-12-29
接口描述
可根据多维度、多指标、多统计数据获取云产品指定时间范围内的监控数据。
接口限制
- 一个实例的任意一个指标一次返回的数据点数目不能超过1440个。
- 每次查询的维度组合数量不超过100个。
请求结构
- method：POST
- 请求URL：/csm/api/v2/data/metricAllData
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户ID | 是 | Body参数 |
| scope | String | 云产品标识，取值请参考云产品标识列表 | 是 | Body参数 |
| region | String | 区域标识，取值请参考区域列表 | 是 | Body参数 |
| type | String | 监控对象类型，默认值：Instance，取值请参考云产品监控对象类型列表 | 是 | Body参数 |
| metricNames | List<String> | 监控指标列表 | 是 | Body参数 |
| statistics | List<String> | 统计方法类型列表，可选值：average、maximum、minimum、sum、sampleCount | 是 | Body参数 |
| dimensions | List<List<Dimension>> | 维度列表 | 是 | Body参数 |
| cycle | int | 统计周期，单位：秒，默认值：60 | 否 | Body参数 |
| startTime | String | 监控数据开始时间，请参考日期与时间，UTC日期表示 | 是 | Body参数 |
| endTime | String | 监控数据结束时间，请参考日期与时间，UTC日期表示 | 是 | Body参数 |
Dimension
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 维度key | 是 |
| value | String | 维度value | 是 |
注：对等连接云产品value请传本端接口ID
参数解释
- 名字空间scope、监控项metric、统计方法Statistic、维度Dimension等的概念请参考核心概念。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求标识ID |
| code | String | 返回码 |
| message | String | 错误信息 |
| metrics | List<AllDataMetric> | 监控指标数据 |
AllDataMetric
| 名称 | 类型 | 描述 |
|---|---|---|
| region | String | 所属区域 |
| scope | String | 云产品名称 |
| userId | String | 用户ID |
| resourceId | String | 资源ID |
| metricName | String | 监控指标名称 |
| dimensions | List<Dimensions> | 监控指标维度列表 |
| dataPoints | List<DataPoint> | 监控指标数据 |
DataPoint
| 名称 | 类型 | 描述 |
|---|---|---|
| average | double | 统计周期内监控项的平均值 |
| sum | double | 统计周期内监控项的和值 |
| minimum | double | 统计周期内监控项的最小值 |
| maximum | double | 统计周期内监控项的最大值 |
| sampleCount | int | 统计周期内监控项数据点数 |
| timestamp | String | 监控数据对应的时间 |
请求示例
JSON
1{
2 "userId": "453bf9********************9090dc",
3 "scope": "BCE_MQ_KAFKA",
4 "region": "bj",
5 "type": "Node",
6 "metricNames": ["CpuUsedPercent"],
7 "statistics": ["average", "sum", "sampleCount"],
8 "dimensions": [
9 [
10 {
11 "name": "ClusterId",
12 "value": "efe456d667******b890652c93812a79"
13 },
14 {
15 "name": "NodeId",
16 "value": "i-Um1V8Haq"
17 }
18 ]
19 ],
20 "cycle": 60,
21 "startTime": "2024-03-21T06:33:50Z",
22 "endTime": "2024-03-21T07:33:50Z"
23}响应示例
JSON
1{
2 "requestId": "f6cb4648-26bd-****-****-4f68afa9d2e6",
3 "code": "success",
4 "message": "",
5 "metrics": [
6 {
7 "region": "bj",
8 "scope": "BCE_MQ_KAFKA",
9 "userId": "453bf9********************9090dc",
10 "resourceId": "i-Um1V8Haq",
11 "metricName": "CpuUsedPercent",
12 "dimensions": [
13 {
14 "name": "ClusterId",
15 "value": "efe456d667******b890652c93812a79"
16 },
17 {
18 "name": "NodeId",
19 "value": "i-Um1V8Haq"
20 }
21 ],
22 "dataPoints": [
23 {
24 "average": 0.959692898272,
25 "sum": 0.959692898272,
26 "sampleCount": 1,
27 "timestamp": "2024-03-21T06:33:50Z"
28 }
29 ]
30 }
31 ]
32}