監控看板:視圖數據查詢
更新時間 2024-09-25 16:20:48
最近更新時間: 2024-09-25 16:20:48
分享文章
監控看板
監控看板:視圖數據查詢
接口功能介紹
查詢看板下某個視圖的數據。
接口約束
參見請求參數說明。
URI
POST /v4/monitor/monitor-board/query-view-data
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| viewID | 是 | String | 面板ID | fb33ae47-415f-4026-23ad-c8492a667e9c | |
| startTime | 否 | Integer | 查詢起始Unix時間戳, startTime和endTime成對使用,且時間間隔不超過31天 | 1667815639 | |
| endTime | 否 | Integer | 查詢結束Unix時間戳, startTime和endTime成對使用,且時間間隔不超過31天 | 1667817639 | |
| fun | 否 | String | 本參數表示聚合類型。默認值為avg。取值范圍:raw:原始值。avg:平均值。min:最小值。max:最大值。variance:方差。sum:求和。根據以上范圍取值。 | avg | |
| period | 否 | Integer | 聚合周期,單位:秒,默認300,需不小于60,推薦使用60的整倍數。當fun為raw時本參數無效。 | 300 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述,適配中英文 | 成功 | |
| error | String | 錯誤碼,請求成功時,不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| viewID | String | 視圖ID | 5ac245b3-dd9b-75c3-cee5-d1b674bb0d69 | |
| viewType | String | 視圖類型。取值范圍:timeSeries:折線圖。gauge:儀表盤。barChart:柱狀圖。table:表格。pieChart:餅狀圖。根據以上范圍取值。 | timeSeries | |
| monitorType | String | 視圖屬性。取值范圍:metric:指標。resource:實例。根據以上范圍取值。 | metric | |
| viewData | Object | 數據 | viewDataObj |
表 viewDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| timeSeriesData | Array of Objects | 折線圖數據 | timeSeriesDataObj | |
| barChartData | Array of Objects | 柱狀圖數據 | barChartDataObj | |
| gaugeData | Object | 儀表盤數據 | gaugeDataObj | |
| pieChartData | Object | 餅狀圖數據 | pieChartDataObj | |
| tableData | Object | 表格數據 | tableDataObj |
表 timeSeriesDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemName | String | 監控項名稱 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | % | |
| compareType | String | 本參數表示比較類型。取值范圍:1d:環比。7d:同比。0d:原始。根據以上范圍取值。 | 1d | |
| itemData | Array of Objects | 折線圖數據 | itemDataTimeSeries | |
| dimensions | Array of Objects | 監控項標簽 | dimension | |
| resource | Array of Objects | 資源 | obj |
表 itemDataTimeSeries
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| value | Double | 監控項值,具體請參考對應監控項文檔 | 524288 | |
| timestamp | Integer | 監控數據Unix時間戳 | 1667815639 |
表 barChartDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemName | String | 監控項名稱 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | % | |
| compareType | String | 本參數表示比較類型。取值范圍:1d:環比。7d:同比。0d:原始。根據以上范圍取值。 | 1d | |
| itemData | Array of Objects | 柱狀圖數據 | itemDataBarChart | |
| dimensions | Array of Objects | 監控項標簽 | dimension | |
| resource | Array of Objects | 資源 | obj |
表 itemDataBarChart
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| value | Double | 監控項值,具體請參考對應監控項文檔 | 524288 | |
| timestamp | Integer | 監控數據Unix時間戳 | 1667815639 |
表 gaugeDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemName | String | 監控項名稱 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | % | |
| rawValue | String | 監控項原始值 | 85 | |
| compareData | Array of Objects | 比較數據 | compareDataObj | |
| minValue | Integer | 表盤最小值 | 0 | |
| maxValue | Integer | 表盤最大值 | 100 | |
| threshold | Array of Integers | 表盤閾值 | [30,80] | |
| resource | Array of Objects | 資源 | obj |
表 pieChartDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemName | String | 監控項名稱 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | % | |
| itemData | Array of Objects | 餅圖數據 | itemDataPieChart |
表 itemDataPieChart
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| rawValue | Double | 監控項原始值 | 85 | |
| compareData | Array of Objects | 比較數據 | compareDataObj | |
| resource | Array of Objects | 資源 | obj | |
| proportion | String | 占比 | 85 |
表 tableDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| tableHead | Array of Strings | 表頭 | ['名稱'] | |
| itemData | Array of Objects | 表格數據 | itemDataTable |
表 itemDataTable
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| service | String | 服務 | ecs | |
| dimension | String | 維度 | ecs | |
| dimensions | Array of Objects | 監控項標簽 | dimension | |
| timestamp | Integer | 監控數據Unix時間戳 | 1667815639 | |
| itemName | String | 監控項名稱 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | % | |
| rawValue | Double | 監控項原始值 | 85 | |
| compareData | Array of Objects | 比較數據 | compareDataObj | |
| resource | Array of Objects | 資源 | obj |
表 compareDataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| value | String | 監控項值,具體請參考對應監控項文檔 | 524288 | |
| compareType | String | 本參數表示比較類型。取值范圍:1d:環比。7d:同比。根據以上范圍取值。 | 1d |
表 obj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| key | String | 資源鍵 | uuid | |
| value | String | 資源鍵對應的值 | xxxx |
表 dimension
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 監控項標簽鍵 | uuid | |
| value | String | 監控項標簽鍵對應的值 | 9dc48979-4e19-45e2-b523-5d3c70d516b3 |
請求示例
請求url
/v4/monitor/monitor-board/query-view-data
請求頭header
無
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"viewID":"fb33ae47-415f-4026-23ad-c8492a667e9c",
"startTime":1665305264,
"endTime":1665391665,
"fun":"avg",
"period":300
}
響應示例
折線圖示例
{
"statusCode":800,
"returnObj":{
"viewID":"5ac245b3-dd9b-75c3-cee5-d1b674bb0d69",
"viewType":"timeSeries",
"monitorType":"resource",
"viewData":{
"timeSeriesData":[
{
"itemName":"mem_util",
"itemDesc":"內存使用率",
"itemUnit":"%",
"compareType":"0d",
"itemData":[
{
"value":20.971920186184,
"timestamp":1711674090
},
{
"value":20.955610239977997,
"timestamp":1711674390
}
],
"dimensions":[
{
"name":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
},
{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"compareType":"0d",
"itemData":[
{
"value":1.0480094529505,
"timestamp":1711674090
},
{
"value":0.9793189884861999,
"timestamp":1711674390
}
],
"dimensions":[
{
"name":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
}
],
"barChartData":[
],
"gaugeData":{
},
"pieChartData":{
},
"formData":{
}
}
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"description": "成功"
}
柱狀圖示例
{
"statusCode":800,
"returnObj":{
"viewID":"4bb245b3-dd9b-75c3-cee5-d1b674bb0d69",
"viewType":"barChart",
"monitorType":"resource",
"viewData":{
"timeSeriesData":[
],
"barChartData":[
{
"itemName":"mem_util",
"itemDesc":"內存使用率",
"itemUnit":"%",
"compareType":"0d",
"itemData":[
{
"value":20.971920186184,
"timestamp":1711674090
},
{
"value":20.955610239977997,
"timestamp":1711674390
}
],
"dimensions":[
{
"name":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
},
{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"compareType":"0d",
"itemData":[
{
"value":1.0480094529505,
"timestamp":1711674090
},
{
"value":0.9793189884861999,
"timestamp":1711674390
}
],
"dimensions":[
{
"name":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
}
],
"gaugeData":{
},
"pieChartData":{
},
"tableData":{
}
}
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"description": "成功"
}
儀表盤數據
{
"statusCode":800,
"returnObj":{
"viewID":"7aa245b3-dd9b-75c3-cee5-d1b674bb0d69",
"viewType":"gauge",
"monitorType":"resource",
"viewData":{
"timeSeriesData":[
],
"barChartData":[
],
"gaugeData":{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"rawValue":"0.95",
"compareData":[
{
"compareType":"1d",
"value":"-2.65"
},
{
"compareType":"7d",
"value":"-1.40"
}
],
"minValue":0,
"maxValue":100,
"threshold":[
30,
80
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
},
"pieChartData":{
},
"tableData":{
}
}
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"description": "成功"
}
餅圖
{
"statusCode":800,
"returnObj":{
"viewID":"3tt245b3-dd9b-75c3-cee5-d1b674bb0d69",
"viewType":"pieChart",
"monitorType":"metric",
"viewData":{
"timeSeriesData":[
],
"barChartData":[
],
"gaugeData":{
},
"pieChartData":{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"itemData":[
{
"rawValue":0.9765625,
"compareData":[
{
"compareType":"1d",
"value":"0.01"
},
{
"compareType":"7d",
"value":"-11.72"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
],
"proportion":"8.88"
},
{
"rawValue":10.020822488287,
"compareData":[
{
"compareType":"1d",
"value":""
},
{
"compareType":"7d",
"value":"64.87"
}
],
"resource":[
{
"key":"uuid",
"value":"1b17707d-d067-cda6-011f-b0bd6b456f78"
}
],
"proportion":"91.12"
}
]
},
"tableData":{
}
}
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"description": "成功"
}
表格
{
"statusCode":800,
"returnObj":{
"viewID":"2ab245b3-dd9b-75c3-cee5-d1b674bb0d69",
"viewType":"table",
"monitorType":"resource",
"viewData":{
"timeSeriesData":[
],
"barChartData":[
],
"gaugeData":{
},
"pieChartData":{
},
"tableData":{
"tableHead":[
"資源類型",
"實例名稱/id",
"時間",
"指標",
"數值",
"環比",
"同比"
],
"itemData":[
{
"service":"ecs",
"dimension":"ecs",
"timestamp":1711674090,
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"rawValue":"0.95",
"compareData":[
{
"compareType":"1d",
"value":"-2.65"
},
{
"compareType":"7d",
"value":"-1.40"
}
],
"resource":[
{
"key":"uuid",
"value":"60608d09-4f6d-533a-13f8-74ec7cdb26d4"
}
]
}
]
}
}
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.ViewNotExist | 視圖不存在 |
| Monitor.DataQuery.AccessFailed | 訪問內部系統失敗 |
| Monitor.DataQuery.ResponseError | 訪問內部系統返回錯誤 |
| 其他 | 參見公共錯誤碼說明 |