站點監控任務：查詢
更新時間 2023-07-19 11:41:06
最(zui)近更新時間(jian): 2023-07-19 11:41:06
分享文(wen)章
接口功能介紹
調(diao)用此(ci)接口可(ke)查詢站點監控任務。
接口約束
資源池ID不能(neng)為空。
URI
GET /v4/monitor/query-site-monitor
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| siteID | String | 否 | 64ea1664-4347-558e-9bc6-651341c2fa15 | 站點監控任務ID | |
| protocol | String | 否 | http | 探測類型 可取值 http ping tcp udp | |
| name | String | 否 | siteMonitor1-修改 | 站點監控任務名稱，支持中英文 | |
| search | String | 否 | baidu | 對站點地址（address）進行模糊搜索 | |
| pageNo | Integer | 否 | 1 | 頁碼，默認為1 | |
| page | Integer | 否 | 1 | 頁碼，默認為1，建議使用pageNo，該參數后續會下線 | |
| pageSize | Integer | 否 | 1 | 頁大小，默認為10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| siteList | Array of Objects | 站點監控任務列表 | site | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 2 | |
| page | Integer | 頁碼，建議參考請求參數pageNo，該參數后續會下線 | 1 | |
| pageSize | Integer | 頁大小，建議參考請求參數pageSize，該參數后續會下線 | 10 |
表site
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| siteID | String | 站點監控任務ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| monitorID | String | 站點監控任務ID（底層） | dkql20221109161309 | |
| name | String | 站點監控任務名稱 | siteMonitor1-修改 | |
| protocol | String | 探測類型 | http | |
| address | String | 站點地址 | //www.baidu.com | |
| evalInterval | Integer | 探測間隔，單位：秒 | 60 | |
| probePoint | Array of String | 探測點 | ["East_China","North_China"] | |
| lastChange | String | 最近更新時間 | 2022-11-09T08:13:09Z | |
| status | Boolean | 狀態 | true |
請求示例
GET /v4/monitor/query-site-monitor?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=5
響應示例
{
"statusCode":800,
"returnObj":{
"siteList":[
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"monitorID":"dkql20221109161309",
"name":"siteMonitor1-修改",
"protocol":"http",
"address":"//www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:13:09Z",
"status":true
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"f1aa04c0-7d93-5d2c-bf9d-3b25623d69c4",
"monitorID":"jaeg20221109161534",
"name":"siteMonitor4-示例",
"protocol":"ping",
"address":"www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:15:34Z",
"status":true
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"monitorID":"fxfm20221109165039",
"name":"siteMonitor4-示例",
"protocol":"ping",
"address":"www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:50:39Z",
"status":true
}
],
"totalCount":3,
"totalPage":1,
"currentCount":3,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.SitemMonitorIDNotFound | 站點ID不存在 |
| 其他 | 參見公共錯誤碼說明 |
