批量查詢實例監控數據
更新時間 2025-09-25 16:16:43
最近更新時間: 2025-09-25 16:16:43
分享文章
接口功能介紹
批量查詢實例監控數據，目前僅支持查詢近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 | 結束時間戳，精確到秒 |
- period取值為15時，startTime和endTime質檢相差不能超過3小時
- period取值為60時，startTime和endTime之間相差不能超過1天
- period取值為900時，startTime和endTime之間相差不能超過15天
- period取值為3600時，startTime和endTime之間相差不能超過30天 | | | | aggFunc | 是 | String | 聚合函數 取值為:
- avg: 表示按照period指定的周期計算平均值
- max: 表示按照period指定的周期計算最大值
- 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
`POST /teledb-dcp/v2/openapi/monitor/instMetricData`
請求頭header
無
請求體body
{
"prodEngineName": "PostgreSQL",
"instIds": ["84989130a75a472894c42eade11e03ff"],
"metricsType": "pg_instance_cpu_utilization",
"period": "15",
"startTime": "1758529371",
"endTime": "1758532974",
"aggFunc": "avg"
}
響應示例
{
"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"
}
狀態碼
請參考
錯誤碼
請參考
