Dimension Value TopN Query Interface
Updated at：2025-11-03
API description
This API retrieves the TopN dimension values for a specified metric under certain dimensions associated with a cloud product instance.
Request parameters
| Name | Types | Description | Required or not | Parameter location |
|---|---|---|---|---|
| userId | String | User ID | Yes | Body |
| scope | String | Cloud product identifier. For values, refer to [Cloud Product Identifier List](BCM/Cloud Product Monitor List/Cloud Product Monitor Object Type List.md) | Yes | Body |
| region | String | Region identifier. For values, refer to [Region List](BCM/API Reference/Service domain.md) | Yes | Body |
| metricName | String | Monitor Metric | Yes | Body |
| statistics | String | Statistic method type. Optional values: average, maximum, minimum, sum, sampleCount. | Yes | Body |
| dimensions | Map<String, String> | Instance dimensions and metric dimensions, instance dimensions: Instance ID or parent instance ID (required); metric dimensions: Dimensions carried by the monitoring metric (optional) | Yes | Body |
| labels | Set<String> | Metric dimensions to be sorted | Yes | Body |
| startTime | String | Monitor data start time, refer to [Date and Time](BCM/API Reference/General Description.md), in UTC format | Yes | Body |
| endTime | String | Monitor data end time, refer to [Date and Time](BCM/API Reference/General Description.md), expressed in UTC date | Yes | Body |
| order | String | Sorting method, optional values top (descending), bottom (ascending), default top | No | Body |
| topNum | int | Number of topNum items retained after sorting, default: 10, maximum: 1000 | No | Body |
Parameter explanation
- For concepts like Scope, Metric, Statistic, and Dimension, refer to [Core Concepts](BCM/Product Description/Core concepts.md).
Response parameters
| Name | Types | Description |
|---|---|---|
| requestId | String | Request identifier ID |
| topDatas | List<TopData> | Sorted list of dimension values |
TopData
| Name | Types | Description |
|---|---|---|
| order | int | Ranking |
| dimensions | List<Dimension> | Dimension Information |
Dimension
| Name | Types | Description |
|---|---|---|
| name | String | Dimension name |
| value | String | Dimension value |
Request example
JSON
1request := &model.TsdbDimensionTopQuery{
2 UserID: "453bf9********************9090dc",
3 Region: "bj",
4 Scope: "BCE_NAT",
5 Dimensions: map[string]string{
6 "NatId": "nat-bm1******vf8",
7 },
8 MetricName: "ConnNumber",
9 Statistics: "average",
10 StartTime: "2024-04-27T07:10:01Z",
11 EndTime: "2024-04-27T07:20:01Z",
12 Labels: []string{
13 "FixIp",
14 },
15 }
16 response, err := bcmClient.GetMetricDimensionTop(request)Response example
JSON
1{
2 "requestId": "34faaba47566446c9ba32cd1d2bf082b",
3 "topDatas": [
4 {
5 "order": 1,
6 "dimensions": [
7 {
8 "name": "FixIp",
9 "value": "192.168.0.16"
10 }
11 ]
12 },
13 {
14 "order": 2,
15 "dimensions": [
16 {
17 "name": "FixIp",
18 "value": "192.168.0.15"
19 }
20 ]
21 }
22 ]
23}