監控面板：視圖查詢
更新時間(jian) 2023-07-19 11:41:02
最近更(geng)新(xin)時間: 2023-07-19 11:41:02
分享文章
接口功能介紹
返回(hui)給(gei)定監控視圖(tu)的(de)所有監控項內容(rong)，包(bao)括(kuo)監控視圖(tu)名稱(cheng)和(he)具體的(de)監控項內容(rong)。
一(yi)個(ge)監控(kong)視圖包含一(yi)個(ge)或(huo)多個(ge)監控(kong)項(xiang)(xiang)，監控(kong)項(xiang)(xiang)為key-value格式。
接口約束
regionID（資(zi)源池）、templateID（監(jian)控面板）、viewID（監(jian)控視圖）存(cun)在(zai)。
URI
GET /v4/monitor/describe-monitor-view
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| templateID | String | 是 | 466d5eb4-4843-11ed-a9b7-005056897257 | 監控面板ID | |
| viewID | String | 是 | 4cb790ae-4894-11ed-b386-005056897257 | 監控視圖ID |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| viewID | String | 監控項所屬視圖ID | 4cb790ae-4894-11ed-b386-005056897257 | |
| viewTitle | String | 監控項所屬視圖名稱 | viewPutTest | |
| itemContent | Object | 查詢到的監控項具體內容，為key-value格式 | itemContent |
表itemContent
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| {itemName} | String | 監控項名稱 | tcKey11 | |
| {value} | Object | 監控項值，與監控項名稱組成key-value格式，可以為任意內容 | tcVal11 |
請求示例
GET /v4/monitor/describe-monitor-view?regionID=81f7728662dd11ec810800155d307d5b&templateID=466d5eb4-4843-11ed-a9b7-005056897257&viewID=4cb790ae-4894-11ed-b386-005056897257
響應示例
{
"statusCode": 800,
"returnObj": {
"viewID": "4cb790ae-4894-11ed-b386-005056897257",
"viewTitle": "viewPutTest",
"itemContent": {
"key1": "val1",
"key2": "newVal2",
"key3": "val3"
}
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 監控面板不存在 |
| Monitor.TemplateView.NotExist | 監控視圖不存在 |
| 其他 | 參見公共錯誤碼說明 |
