自定義監控：查詢趨勢監控數據
更新時間 2024-09-25 16:20:51
最近更新時間: 2024-09-25 16:20:51
分享文章
自定義監控
自定義監控：查詢趨勢監控數據
接口功能介紹
查詢指定自定義監控的時序指標趨勢監控數據。
接口約束
regionID（資源池）、customItemID（自定義監控項ID）存在。
URI
POST /v4/monitor/query-custom-item-trendmetricdata
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 是 | String | 自定義監控項ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| startTime | 是 | String | 查詢起始時間戳 | 1667815639 | |
| endTime | 是 | String | 查詢結束時間戳 | 1667817639 | |
| period | 否 | Integer | 聚合周期，單位：秒，默認300 | 300 | |
| dimensions | 否 | Array of Objects | 自定義監控項維度 | dimValue |
表 dimValue
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 維度名稱 | host | |
| value | 是 | Array of Strings | 維度值 | ['自定義值1','自定義值2'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| result | Array of Objects | 返回數據結果 | result |
表 result
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 | |
|---|---|---|---|---|---|
| regionID | String | 所屬資源池ID | 81f7728662dd11ec810800155d307d5b | ||
| customItemID | String | 自定義監控項ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | ||
| data | Array of Objects | 監控項值列表 | data | ||
| dimensions | Array of Objects | 自定義監控項維度 | dimValue |
表 data
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| samplingTime | Integer | 監控數據采樣時間 | 1667815639 | |
| max | Double | 監控項最大值 | 0.35 | |
| min | Double | 監控項最小值 | 0.35 | |
| avg | Double | 監控項平均值 | 0.35 | |
| variance | Double | 監控項方差 | 0.00 |
表 dimValue
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 維度名稱 | instance | |
| value | String | 維度值 | 127.0.0.1 |
請求示例
請求url
/v4/monitor/query-custom-item-trendmetricdata
請求頭header
無
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"startTime":1687158009,
"customItemID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"period":300,
"endTime":1687158309,
"dimensions":[
{
"name":"uuid",
"value":[
"00350e57-67af-f1db-1fa5-20193d873f5d",
"ss-1aytcbcirhhrgkvubwkcmf8lqpsb"
]
},
{
"name":"job",
"value":[
"virtual_machine",
"bare_metal"
]
}
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"result": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"data": [
{
"max": 1.32,
"min": 1.32,
"avg": 1.32,
"variance": 0.00,
"samplingTime": 1687845502
},
{
"max": 0.91,
"min": 0.91,
"avg": 0.91,
"variance": 0.00,
"samplingTime": 1687845802
}
],
"dimensions": [
{
"name": "uuid",
"value": "ss-1aytcbcirhhrgkvubwkcmf8lqpsb"
},
{
"name": "job",
"value": "bare_metal"
},
{
"name": "sss",
"value": ""
}
]
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"data": [
{
"max": 0.3665,
"min": 0.3665,
"avg": 0.3665,
"variance": 0.00,
"samplingTime": 1687845502
},
{
"max": 0.3665,
"min": 0.3665,
"avg": 0.3665,
"variance": 0.00,
"samplingTime": 1687845802
}
],
"dimensions": [
{
"name": "uuid",
"value": "00350e57-67af-f1db-1fa5-20193d873f5d"
},
{
"name": "job",
"value": "virtual_machine"
},
{
"name": "sss",
"value": ""
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.QueryError | 查詢數據失敗 |
| 其他 | 參見公共錯誤碼說明 |
