部分维度查询监控数据
接口描述
可根据多维度、单指标、多统计数据获取云产品指定时间范围内的监控数据。
接口限制
- 一个实例的任意一个指标一次返回的数据点数目不能超过1440个。
- 每次查询的维度组合数量不超过100个。
请求结构
- Method: POST
- Url: /csm/api/v2/userId/{userId}/services/{service}/data/metricData/PartialDimension
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户 ID |
是 |
Path参数 |
service |
String |
云产品标识,取值请参考云产品标识列表 |
是 |
Path参数 |
startTime |
String |
监控数据开始时间,请参考日期与时间, UTC日期表示 |
是 |
Body参数 |
endTime |
String |
监控数据结束时间,请参考日期与时间,UTC日期表示 |
是 |
Body参数 |
statistics |
List<String> |
统计方法类型列表,可选值:average、maximum、minimum、sum、sampleCount |
是 |
Body参数 |
cycle |
int |
统计周期,单位:秒,默认值:60 |
否 |
Body参数 |
dimensions |
List<Dimension> |
维度列表 |
是 |
Body参数 |
resourceType |
String |
监控对象类型,取值请参考云产品监控对象类型列表 |
否 |
Body参数 |
metricName |
String |
监控指标名称 |
是 |
Body参数 |
region |
String |
区域标识,取值请参考区域列表 |
否 |
Body参数 |
pageNo |
int |
页面序号,默认为1 |
否 |
Body参数 |
pageSize |
int |
页面大小,默认为10,最大为100 |
否 |
Body参数 |
Dimension
名称 |
类型 |
描述 |
是否必须 |
name |
String |
维度key |
是 |
value |
String |
维度value |
是 |
响应参数
名称 |
类型 |
描述 |
requestId |
String |
请求标识 |
code |
String |
返回码 |
message |
String |
错误信息 |
result |
PageResult |
按页封装的结果 |
名称 |
类型 |
描述 |
pageNo |
int |
页码编号 |
pageSize |
int |
页面大小 |
totalCount |
int |
总共个数 |
result |
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 |
监控数据对应的时间 |
请求示例
1POST /csm/api/v2/userId/453bf9588c9*******a2c984129090dc/services/BCE_BLB/data/metricData/PartialDimension
2{
3 "startTime" : "2024-03-20T02:21:17Z",
4 "endTime" : "2024-03-20T03:21:17Z",
5 "dimensions" : [
6 {
7 "name" : "BlbPortType",
8 "value" : "TCP"
9 }
10 ],
11 "statistics" : [
12 "sum"
13 ],
14 "resourceType" : "AppIpv6Blb",
15 "metricName" : "ActiveConnClusterPercent"
16}
响应示例
1{
2 "requestId": "55b74de262694686999adad5b4832047",
3 "code": "success",
4 "message": "",
5 "result": {
6 "pageNo": 1,
7 "pageSize": 10,
8 "totalCount": 4,
9 "result": [
10 {
11 "region": "bj",
12 "scope": "BCE_BLB",
13 "userId": "453bf9588c9*******a2c984129090dc",
14 "resourceId": "lb-****f1c3",
15 "metricName": "ActiveConnClusterPercent",
16 "dimensions": [
17 {
18 "name": "BlbId",
19 "value": "lb-****f1c3"
20 },
21 {
22 "name": "BlbPort",
23 "value": "80"
24 },
25 {
26 "name": "BlbPortType",
27 "value": "TCP"
28 }
29 ],
30 "dataPoints": [
31 {
32 "sum": 0.0,
33 "timestamp": "2024-03-20T02:21:17Z"
34 },
35 {
36 "sum": 0.0,
37 "timestamp": "2024-03-20T02:22:17Z"
38 }
39 .....
40 ]
41 }
42 ....
43 ]
44 }
45}
![]()