批量查询监控数据接口V2
接口描述
可根据多维度、多指标、多统计数据获取云产品指定时间范围内的监控数据。
接口限制
- 一个实例的任意一个指标一次返回的数据点数目不能超过1440个。
- 每次查询的维度组合数量不超过100个。
请求结构
- method：POST
- 请求URL：/csm/api/v2/data/metricAllData
请求参数
| 名称 |
类型 |
描述 |
是否必须 |
参数位置 |
| userId |
String |
用户ID |
是 |
Body参数 |
| scope |
String |
云产品标识，取值请参考云产品标识列表 |
是 |
Body参数 |
| region |
String |
区域标识，取值请参考区域列表 |
是 |
Body参数 |
| type |
String |
监控对象类型，默认值：Instance，取值请参考云产品监控对象类型列表 |
是 |
Body参数 |
| metricNames |
List<String> |
监控指标列表 |
是 |
Body参数 |
| statistics |
List<String> |
统计方法类型列表，可选值：average、maximum、minimum、sum、sampleCount |
是 |
Body参数 |
| dimensions |
List<List<Dimension>> |
维度列表 |
是 |
Body参数 |
| cycle |
int |
统计周期，单位：秒，默认值：60 |
否 |
Body参数 |
| startTime |
String |
监控数据开始时间，请参考日期与时间，UTC日期表示 |
是 |
Body参数 |
| endTime |
String |
监控数据结束时间，请参考日期与时间，UTC日期表示 |
是 |
Body参数 |
Dimension
| 名称 |
类型 |
描述 |
是否必须 |
| name |
String |
维度key |
是 |
| value |
String |
维度value |
是 |
参数解释
- 名字空间scope、监控项metric、统计方法Statistic、维度Dimension等的概念请参考核心概念。
响应参数
| 名称 |
类型 |
描述 |
| requestId |
String |
请求标识ID |
| 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 |
统计周期内监控项数据点数 |
| timestamp |
String |
监控数据对应的时间 |
请求示例
{
"userId": "453bf9********************9090dc",
"scope": "BCE_MQ_KAFKA",
"region": "bj",
"type": "Node",
"metricNames": ["CpuUsedPercent"],
"statistics": ["average", "sum", "sampleCount"],
"dimensions": [
[
{
"name": "ClusterId",
"value": "efe456d667******b890652c93812a79"
},
{
"name": "NodeId",
"value": "i-Um1V8Haq"
}
]
],
"cycle": 60,
"startTime": "2024-03-21T06:33:50Z",
"endTime": "2024-03-21T07:33:50Z"
}
响应示例
{
"requestId": "f6cb4648-26bd-****-****-4f68afa9d2e6",
"code": "success",
"message": "",
"metrics": [
{
"region": "bj",
"scope": "BCE_MQ_KAFKA",
"userId": "453bf9********************9090dc",
"resourceId": "i-Um1V8Haq",
"metricName": "CpuUsedPercent",
"dimensions": [
{
"name": "ClusterId",
"value": "efe456d667******b890652c93812a79"
},
{
"name": "NodeId",
"value": "i-Um1V8Haq"
}
],
"dataPoints": [
{
"average": 0.959692898272,
"sum": 0.959692898272,
"sampleCount": 1,
"timestamp": "2024-03-21T06:33:50Z"
}
]
}
]
}
![]()
