部分维度查询最新指标数据
更新时间：2024-04-18
接口描述
可根据多维度、多指标、多统计数据获取云产品指定时刻指标监控数据、站点监控数据或您推送的自定义监控数据。
接口限制
- 每次查询的维度组合数量不超过100个。
- 每次查询的指标名称数量不超过30个。
请求结构
- 请求方法：POST
- 请求URL：/csm/api/v2/userId/{userId}/services/{scope}/data/metricData/latest/batch
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户ID | 是 | Body参数 |
| scope | String | 云产品标识，取值请参考云产品标识列表 | 是 | Body参数 |
| region | String | 区域标识，取值请参考区域列表 | 是 | Body参数 |
| resourceType | String | 监控对象类型，默认值：Instance，取值请参考云产品监控对象类型列表 | 否 | Body参数 |
| metricNames | List<String> | 监控指标列表 | 是 | Body参数 |
| statistics | List<String> | 统计方法类型列表，可选值：average、maximum、minimum、sum、sampleCount。为空时默认返回最新原始值 | 否 | Body参数 |
| dimensions | List<Dimension> | 维度列表 | 否 | Body参数 |
| cycle | int | 统计周期，单位：秒，默认为60，上限为3600 | 否 | Body参数 |
| timestamp | DateTime | 监控项统计周期对应的时间，默认为当前时间。请参考日期与时间，UTC日期表示 | 是 | Body参数 |
Dimension
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| name | String | 维度key | 是 | Body参数 |
| value | String | 维度value | 是 | Body参数 |
参数解释
-云产品标识scope、监控项metric、统计方法Statistic、维度Dimension等概念请参考核心概念。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求标识 |
| 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 | 统计周期内监控项数据点数 |
| value | int | 统计周期内监控项的原始值 |
| timestamp | DateTime | 监控项统计周期对应的时间，请参考日期与时间，UTC日期表示 |
请求示例
JSON
1POST /csm/api/v2/userId/user1/services/BCE_BLB/data/metricData/latest/batch HTTP/1.1
2Host:bcm.bj.baidubce.com:80
3{
4 "userId" : "453bf9588c*****f9ba2c984129090dc",
5 "region" : "bj",
6 "scope" : "BCE_BLB",
7 "resourceType" : "Instance",
8 "dimensions" : [
9 {
10 "name": "BlbId",
11 "value": "lb-8ce1****"
12 },
13 {
14 "name": "BlbPort",
15 "value": "8200"
16 }
17 ],
18 "metricNames": [
19 "ActiveConnCount"
20 ],
21 "timestamp" : "2024-03-18T06:01:00Z"
22 "statistics":[
23 "average",
24 "sum",
25 "minimum"
26 ],
27 "cycle" : 60
28}响应示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: 8a53f39b25ff44c6b2f9ac5b75377bbb
3Content-Type: application/json;charset=UTF-8
4{
5 "requestId": "8a53f39b25ff44c6b2f9ac5b75377bbb",
6 "code": "success",
7 "message": null,
8 "metrics": [
9 {
10 "region": "bj",
11 "scope": "BCE_BLB",
12 "userId": "453bf9588c9*******a2c984129090dc",
13 "resourceId": "lb-8ce1e1a0",
14 "metricName": "ActiveConnCount",
15 "dimensions": [
16 {
17 "name": "BlbId",
18 "value": "lb-8ce1****"
19 },
20 {
21 "name": "BlbPort",
22 "value": "8200"
23 },
24 {
25 "name": "BlbPortType",
26 "value": "TCP"
27 }
28 ],
29 "dataPoints": [
30 {
31 "average": 3.0,
32 "sum": 3.0,
33 "minimum": 3.0,
34 "timestamp": "2024-03-18T06:01:00Z"
35 }
36 ]
37 }
38 ]
39}