監控面板：查詢
更(geng)新時間 2023-07-19 11:41:02
最近更新時間: 2023-07-19 11:41:02
分享文章
接口功能介紹
查(cha)看指定資(zi)源池內的(de)所有監(jian)控(kong)面板(ban)的(de)具體(ti)內容，或者(zhe)查(cha)看某一指定監(jian)控(kong)面板(ban)的(de)內容。
接口約束
regionID（資源池(chi)）存(cun)在(zai)，如(ru)果查詢指(zhi)定監控面(mian)板內容，則需(xu)要templateID（監控面(mian)板）存(cun)在(zai)。
URI
GET /v4/monitor/describe-monitor
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| templateID | String | 否 | 0bf803e8-5049-11ed-8fb7-005056897257 | 監控面板ID | |
| pageNo | Integer | 否 | 1 | 頁碼，默認為1 | |
| page | Integer | 否 | 1 | 頁碼，默認為1，建議使用pageNo，該參數后續會下線 | |
| pageSize | Integer | 否 | 2 | 頁大小，默認為10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateList | Array of Objects | 監控面板具體內容 | templateList | |
| totalCount | Integer | 查詢到的監控面板個數 | 1 | |
| page | Integer | 頁碼，建議參考請求參數pageNo，該參數后續會下線 | 1 | |
| pageSize | Integer | 頁大小，建議參考請求參數pageSize，該參數后續會下線 | 10 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 14 |
表(biao)templateList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateID | String | 監控面板ID | 0bf803e8-5049-11ed-8fb7-005056897257 | |
| name | String | 監控面板名稱 | whGHk | |
| regionCtyunID | String | 監控面板所屬資源池ID | 81f7728662dd11ec810800155d307d5b | |
| fuserLastUpdated | String | 上次更新時間 | 2022-10-20T07:30:19Z | |
| list | Array of Objects | 監控視圖具體內容 | list |
表list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| title | String | 監控視圖名稱 | testViewName | |
| content | Array of Objects | 監控項具體內容，為key-value格式 | content | |
| viewID | String | 監控視圖ID | 4cb790ae-4894-11ed-b386-005056897257 |
表content
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| {itemName} | String | 監控項名稱 | dim | |
| {value} | Object | 監控項值，與監控項名稱組成key-value格式，可以為任意內容 | turn-test8 |
請求示例
GET /v4/monitor/describe-monitor?regionID=81f7728662dd11ec810800155d307d5b&templateID=d9f53eb4-616f-11ed-80c4-005056897257&page=1&pageSize=3
響應示例
{
"statusCode": 800,
"returnObj": {
"templateList": [
{
"templateID": "d9f53eb4-616f-11ed-80c4-005056897257",
"name": "new_template2022-11-11 11:20:52.515426",
"regionCtyunID": "81f7728662dd11ec810800155d307d5b",
"fuserLastUpdated": "2022-11-21T07:42:26Z",
"list": [
{
"viewID": "0b21c108-6970-11ed-aa29-005056897257",
"title": "測試2",
"content": [
{
"dim": "site_monitor",
"ser": "site_monitor",
"regionid": "81f7728662dd11ec810800155d307d5b",
"uuidName": "turn-test8",
"item": "ping_average_response_ms",
"selectedOptions": [
"6d3867dd-5884-1e08-01e8-f4a7cc711f04"
],
"uuid": "6d3867dd-5884-1e08-01e8-f4a7cc711f04"
}
]
}
]
}
],
"totalCount": 1,
"page": 1,
"pageSize": 3,
"totalPage": 1,
"currentCount": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 監控面板不存在 |
| 其他 | 參見公共錯誤碼說明 |
