搜索本产品文档关键词
批量查询监控数据接口V2
所有文档
menu

云监控 BCM

批量查询监控数据接口V2

接口描述

可获取多实例、多指标、多统计数据的接口,可获取云产品监控数据、站点监控数据或您推送的自定义监控数据。

接口限制

  • 一个实例的任意一个指标一次返回的数据点数目不能超过1440个。
  • 一次请求最多支持查询100个实例。

请求参数

名称
类型
描述
是否必须
参数位置
userId string 用户ID Body参数
scope string 云产品标识,请参考云产品标识列表 Body参数
region string 区域标识,取值请参考区域列表 Body参数
type string 监控对象类型,请参考监控对象类型列表 Body参数
metricNames string[] 监控指标列表,仅限于使用如下字符集合:"0~9、A~Z、a~z"、 "_"
当需要查找多个指标项时,使用String数组存储,每个数组元素为一个指标项
Body参数
statistics string[] 统计方法类型列表,可选值为average、maximum、minimum、sum、sampleCount,需要查询多个统计值时,使用String数组存储 Body参数
dimensions Dimension[][] 维度列表,当需要查询多个实例的数据时,使用二维数组查询。一层数组设置多个实例,二层数组设置多个维度 Body参数
startTime string 查询起始时间,请参考日期与时间,UTC日期表示 Body参数
endTime string 查询截止时间,请参考日期与时间,UTC日期表示 Body参数
cycle int 统计周期,60的倍数,单位:秒 Body参数

Dimension

名称
类型
描述
name string 维度key
value string 维度value

参数解释

  • 名字空间scope、监控项metric、统计方法Statistic、维度Dimension等的概念请参考核心概念

响应结果

名称
类型
描述
requestId string 请求标识
code string 返回码
message string 错误信息
metrics AllDataMetric[] 监控指标

AllDataMetric

名称
类型
描述
region string 区域
scope string 云产品标识
userId string 用户Id
resourceId string 资源Id
metricName string 指标名称
dimensions Dimension[] 维度列表
dataPoints DataPoints[] 指标数据

DataPoints

名称
类型
描述
average float64 统计周期内监控项的平均值
sum float64 统计周期内监控项的和值
minimum float64 统计周期内监控项的最小值
maximum float64 统计周期内监控项的最大值
sampleCount int 统计周期内监控项数据点数
timestamp string 监控项统计周期对应的时间,请参考日期与时间,UTC日期表示

请求示例

Plain Text
1req := &model.TsdbMetricAllDataQueryRequest{
2    UserID: "453bf9********************9090dc",
3    Scope:  "BCE_BCC",
4    Region: "bj",
5    Type: "Instance",
6    Dimensions: [][]model.Dimension{
7        {
8            {
9                Name:  "InstanceId",
10                Value: "i-DMxr6UxX",
11            },
12        },
13        {
14            {
15                Name:  "InstanceId",
16                Value: "i-Y8NAmymd",
17            },
18        },
19    },
20    Statistics:  []string{"average", "sum"},
21    StartTime:   "2024-03-20T07:01:00Z",
22    EndTime:     "2024-03-20T07:05:00Z",
23    MetricNames: []string{"CPUUsagePercent", "MemUsedPercent"},
24}
25response, err := bcmClient.GetMetricsAllDataV2(req)

返回结果

Plain Text
1{
2      "requestId": "54dbc0dc-185c-4821-987c-36a50d6f853d",
3      "code": "success",
4      "message": "",
5      "metrics": [
6            {
7                  "region": "bj",
8                  "scope": "BCE_BCC",
9                  "userId": "453bf9588c9e488f9ba2c984129090dc",
10                  "resourceId": "i-DMxr6UxX",
11                  "metricName": "CPUUsagePercent",
12                  "dimensions": [
13                        {
14                              "name": "InstanceId",
15                              "value": "i-DMxr6UxX"
16                        }
17                  ],
18                  "dataPoints": [
19                        {
20                              "average": 7.883685650352,
21                              "sum": 15.767371300704,
22                              "timestamp": "2024-03-20T07:01:00Z"
23                        }
24                  ]
25            },
26            {
27                  "region": "bj",
28                  "scope": "BCE_BCC",
29                  "userId": "453bf9588c9e488f9ba2c984129090dc",
30                  "resourceId": "i-Y8NAmymd",
31                  "metricName": "CPUUsagePercent",
32                  "dimensions": [
33                        {
34                              "name": "InstanceId",
35                              "value": "i-Y8NAmymd"
36                        }
37                  ],
38                  "dataPoints": [
39                        {
40                              "average": 28.7611908111665,
41                              "sum": 57.522381622333,
42                              "timestamp": "2024-03-20T07:01:00Z"
43                        }
44                  ]
45            },
46            {
47                  "region": "bj",
48                  "scope": "BCE_BCC",
49                  "userId": "453bf9588c9e488f9ba2c984129090dc",
50                  "resourceId": "i-DMxr6UxX",
51                  "metricName": "MemUsedPercent",
52                  "dimensions": [
53                        {
54                              "name": "InstanceId",
55                              "value": "i-DMxr6UxX"
56                        }
57                  ],
58                  "dataPoints": [
59                        {
60                              "average": 20.727214027726,
61                              "sum": 41.454428055452,
62                              "timestamp": "2024-03-20T07:01:00Z"
63                        }
64                  ]
65            },
66            {
67                  "region": "bj",
68                  "scope": "BCE_BCC",
69                  "userId": "453bf9588c9e488f9ba2c984129090dc",
70                  "resourceId": "i-Y8NAmymd",
71                  "metricName": "MemUsedPercent",
72                  "dimensions": [
73                        {
74                              "name": "InstanceId",
75                              "value": "i-Y8NAmymd"
76                        }
77                  ],
78                  "dataPoints": [
79                        {
80                              "average": 20.772412679829998,
81                              "sum": 41.544825359659995,
82                              "timestamp": "2024-03-20T07:01:00Z"
83                        }
84                  ]
85            }
86      ]
87}
上一篇
批量数据查询接口
下一篇
部分维度查询监控数据