维度值TopN和监控数据查询接口
更新时间：2024-07-15
接口描述
该接口可获取某个云产品实例下某个指标名的某些维度下的维度值TopN以及对应的监控数据。
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户ID | 是 | Body参数 |
| scope | String | 云产品标识，取值请参考云产品标识列表 | 是 | Body参数 |
| region | String | 区域标识，取值请参考区域列表 | 是 | Body参数 |
| metricName | String | 监控指标名，仅限于使用如下字符集合："0~9、A~Z、a~z"、 "_" | 是 | Body参数 |
| statistics | String | 统计方法类型，可选值：average、maximum、minimum、sum、sampleCount | 是 | Body参数 |
| dimensions | Map<String, String> | 实例维度和指标维度，实例维度：实例Id或父实例Id（必填）；指标维度：监控指标携带的维度（选填） | 是 | Body参数 |
| labels | Set<String> | 需要排序的指标维度 | 是 | Body参数 |
| startTime | String | 监控数据开始时间，请参考日期与时间，UTC日期表示 | 是 | Body参数 |
| endTime | String | 监控数据结束时间，请参考日期与时间，UTC日期表示 | 是 | Body参数 |
| order | String | 排序方式，可选值top（从大到小）、bottom（从小到大），默认top | 否 | Body参数 |
| topNum | int | 排序后保留的前topNum数量，默认值：10，最大为1000 | 否 | Body参数 |
| cycle | int | 统计周期，单位：秒，默认值：60 | 否 | Body参数 |
参数解释
- 名字空间scope、监控项metric、统计方法Statistic、维度Dimension等的概念请参考核心概念。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求标识ID |
| userId | String | 用户ID |
| serviceName | String | 云产品标识 |
| metricName | String | 指标名 |
| resourceId | String | 实例ID |
| dimensions | List<Dimension> | 指标维度 |
| dataPoints | List<TsdbQueryDataPoint> | 监控指标数据 |
Dimension
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 维度名 |
| value | String | 维度值 |
TsdbQueryDataPoint
| 名称 | 类型 | 描述 |
|---|---|---|
| timestamp | String | 监控数据对应的时间 |
| average | float | 统计周期内监控项的平均值 |
| sum | float | 统计周期内监控项的和值 |
| maximum | float | 统计周期内监控项的最大值 |
| minimum | float | 统计周期内监控项的最小值 |
| sampleCount | int | 统计周期内监控项数据点数 |
请求示例
JSON
1request := &model.TsdbDimensionTopQuery{
2 UserID: "453bf9********************9090dc",
3 Region: "bj",
4 Scope: "BCE_NAT",
5 Dimensions: map[string]string{
6 "NatId": "nat-be********cw",
7 },
8 MetricName: "ConnNumber",
9 Statistics: "average",
10 StartTime: "2024-07-08T11:30:53Z",
11 EndTime: "2024-07-08T11:32:53Z",
12 Labels: []string{
13 "FixIp",
14 },
15 cycle: 60
16 }
17 response, err := bcmClient.GetMetricDimensionTopData(request)响应示例
JSON
1[
2 {
3 "requestId": "3adb033a103945c0921914c4c23d6ab8",
4 "userId": "453bf9********************9090dc",
5 "serviceName": "BCE_NAT",
6 "metricName": "ConnNumber",
7 "resourceId": "nat-be********cw",
8 "dimensions": [
9 {
10 "name": "FixIp",
11 "value": "100.2.107.13"
12 }
13 ],
14 "dataPoints": [
15 {
16 "timestamp": "2024-07-08T11:30:53Z",
17 "average": 335.0
18 },
19 {
20 "timestamp": "2024-07-08T11:31:53Z",
21 "average": 367.0
22 },
23 {
24 "timestamp": "2024-07-08T11:32:53Z",
25 "average": 456.0
26 }
27 ]
28 },
29 {
30 "requestId": "3adb033a103945c0921914c4c23d6ab8",
31 "userId": "453bf9********************9090dc",
32 "serviceName": "BCE_NAT",
33 "metricName": "ConnNumber",
34 "resourceId": "nat-be********cw",
35 "dimensions": [
36 {
37 "name": "FixIp",
38 "value": "100.2.107.14"
39 }
40 ],
41 "dataPoints": [
42 {
43 "timestamp": "2024-07-08T11:30:53Z",
44 "average": 153.0
45 },
46 {
47 "timestamp": "2024-07-08T11:31:53Z",
48 "average": 148.0
49 },
50 {
51 "timestamp": "2024-07-08T11:32:53Z",
52 "average": 142.0
53 }
54 ]
55 }
56]