批量查询实例监控数据
更新时间 2025-09-25 16:18:26
最近更新时间: 2025-09-25 16:18:26
接口功能介绍
批量查询实例监控数据，目前仅支持查询近30天的监控数据
接口约束
每分钟最多请求200次
URI
POST /teledb-dcp/v2/openapi/monitor/instMetricData/batch
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodEngineName | 是 | String | 实例类型 目前仅支持Mysql, PostgreSQL | Mysql | |
| instIds | 是 | Array of Strings | 实例Id, 当前最多一次查询20个实例 | ||
| metricsType | 是 | String | 指标 | ||
| period | 是 | Integer | 周期,取值为: 15, 60, 900, 3600 | 15 | |
| startTime | 是 | Long | 开始时间戳，精确到秒 | ||
| endTime | 是 | Long | 结束时间戳，精确到秒 1. period取值为15时，startTime和endTime质检相差不能超过3小时 2. period取值为60时，startTime和endTime之间相差不能超过1天 3. period取值为900时，startTime和endTime之间相差不能超过15天 4. period取值为3600时，startTime和endTime之间相差不能超过30天 | ||
| aggFunc | 是 | String | 聚合函数 取值为: 1. avg: 表示按照period指定的周期计算平均值 2. max: 表示按照period指定的周期计算最大值 3. min: 表示按照period指定的周期计算最小值 | avg |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口状态码，参考下方状态码 | 200 | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | TELEDB_DCP_1000 | |
| message | String | 描述信息 | ||
| returnObj | Object | 返回对象 | ReturnObjDTO | |
| 表 ReturnObjDTO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 指标详情数据 | MetricData | |
| 表 MetricData |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| metricsType | String | 指标名 | ||
| label | Object | 标签 | Label | |
| dataPoints | Array of Objects | 监控数据 | DataPoint | |
| 表 Label |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| outProdInstId | String | 实例id | ||
| vpcIp | String | 机器ip | ||
| regionId | String | 资源池id | ||
| device | String | 设备名,例如硬盘设备名 | vda | |
| state | String | 设备名,例如硬盘设备名 | v | |
| type | String | 设备名,例如硬盘设备名 | v | |
| 表 DataPoint |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| avg | String | 平均值，当aggFun为avg时，返回此字段 | ||
| max | String | 最大值，当aggFun为max时，返回此字段 | ||
| min | String | 最小值，当aggFun为min时，返回此字段 | ||
| timestamp | Long | 时间戳 |
枚举参数
无
请求示例
请求url
`GET /teledb-dcp/v2/openapi/monitor/instMetricData?prodEngineName=POSTGRESQL&instId=0099977d30d6417292a09e2053dde078&metricsType=mysql_monitor_tcp_states&startTime=1733207910&endTime=1733211510&period=15&&aggFunc=max`
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"data": [
{
"storageType": "SATA",
"storageTypeName": "普通IO",
"storageTypeEnName": null,
"id": null,
"description": null
},
{
"storageType": "SAS",
"storageTypeName": "高IO",
"storageTypeEnName": null,
"id": null,
"description": null
}
]
},
"statusCode": 200,
"message": "ok"
}
状态码
请参考 状态码
错误码
请参考 错误码
