站點監控任務：查詢
更新時間 2024-09-25 16:20:52
最近更新時間: 2024-09-25 16:20:52
分享文章
站點監控
站點監控任務：查詢
接口功能介紹
調用此接口可查詢站點監控任務。
接口約束
無
URI
GET /v4/monitor/query-site-monitor
路徑參數
無
Query 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| protocol | 否 | String | 本參數表示探測類型。取值范圍：http：http 探測。ping：ping 探測。tcp：tcp 探測。udp：udp 探測。根據以上范圍取值。 | http | |
| taskName | 否 | String | 站點監控任務名稱，支持中英文 | siteMonitor1-修改 | |
| taskID | 否 | String | 站點監控任務 ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| search | 否 | String | 對站點地址（address）進行模糊搜索 | baidu | |
| pageNo | 否 | Integer | 頁碼，默認為 1 | 1 | |
| pageSize | 否 | Integer | 頁大小，默認為 10 | 1 | |
| sort | 否 | String | 本參數表示排序字段。取值范圍：avgAvailability：可用率。avgResponseTime：平均響應時間。根據以上范圍取值。 | avgResponseTime | |
| asc | 否 | Integer | 本參數表示排序字段。取值范圍：0：倒序。1：正序。根據以上范圍取值。 | 1 |
請求參數
請求頭 header 參數
無
請求體 body 參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800 為成功，900 為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| taskList | Array of Objects | 站點監控任務列表 | task | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 2 |
表 task
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| taskID | String | 站點監控任務 ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| taskName | String | 站點監控任務名稱 | siteMonitor1-修改 | |
| protocol | String | 本參數表示探測類型。取值范圍：http：http 探測。ping：ping 探測。tcp：tcp 探測。udp：udp 探測。根據以上范圍取值。 | http | |
| address | String | 站點地址 | //www.baidu.com | |
| evalInterval | Integer | 本參數表示探測間隔，單位秒。取值范圍：60：60s。300：300s。1200：1200s。1800：1800s。根據以上范圍取值。 | 60 | |
| probePoint | Array of Strings | 探測點 | ['East_China','North_China'] | |
| lastChange | String | 最近更新時間 | 2022-11-09T08:13:09Z | |
| status | Boolean | 狀態 | true | |
| avgAvailability | String | 可用率，單位% | 49.58 | |
| avgResponseTime | String | 平均響應時間，單位毫秒 | 185.40 |
請求示例
請求 url
/v4/monitor/query-site-monitor?pageNo=1&pageSize=5
請求頭 header
無
請求體 body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"taskList": [
{
"taskID": "2ff8065f-59d1-473d-84c4-5f6abf4742f2",
"taskName": "ping測試",
"protocol": "ping",
"address": "55.242.30.32",
"evalInterval": 60,
"probePoint": ["1", "2"],
"status": true,
"lastChange": "2023-11-28 15:27:14",
"avgAvailability": "100.00",
"avgResponseTime": "0.00"
},
{
"taskID": "fdad7b78-9d90-4321-a8c5-f3f3495edcb5",
"taskName": "http測試",
"protocol": "http",
"address": "//www.baidu.com",
"evalInterval": 60,
"probePoint": ["1", "2"],
"status": true,
"lastChange": "2023-11-28 15:18:39",
"avgAvailability": "50.00",
"avgResponseTime": "62.00"
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.SitemMonitorIDNotFound | 站點 ID 不存在 |
| 其他 | 參見公共錯誤碼說明 |
