站點監控任務：修改
更新時間 2024-09-25 16:20:53
最近更新時間: 2024-09-25 16:20:53
分享文章
站點監控
站點監控任務：修改
接口功能介紹
調用此接口可修改站點監控任務。
接口約束
站點監控任務ID，站點監控任務名稱，探測間隔，探測類型，探測地址，探測點ID列表不為空，且探測節點應可用。
URI
POST /v4/monitor/modify-site-monitor
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| taskID | 是 | String | 站點監控任務ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| taskName | 是 | String | 站點監控任務名稱，支持中英文 | siteMonitor1-修改 | |
| protocol | 是 | String | 本參數表示探測類型，不可更改。取值范圍：http：http探測。ping：ping探測。tcp：tcp探測。udp：udp探測。根據以上范圍取值。 | http | |
| address | 是 | String | 站點地址，當探測類型為tcp或udp時可以更改端口號，其他情況不可更改。ping示例：www.baidu.comtcp/udp示例：www.baidu.com:80http示例：//www.baidu.com或//www.baidu.com | //www.baidu.com | |
| evalInterval | 是 | Integer | 本參數表示探測間隔，單位秒。取值范圍：60：60s。300：300s。1200：1200s。1800：1800s。根據以上范圍取值。 | 60 | |
| probePoint | 是 | Array of Strings | 探測節點列表，如['1','2']，可用探測節點可通過探測節點：查詢列表接口獲取 | ['1'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| taskID | String | 站點監控任務ID | 64ea1664-4347-558e-9bc6-651341c2fa15 |
請求示例
請求url
/v4/monitor/modify-site-monitor
請求頭header
無
請求體body
{
"taskID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"taskName":"siteMonitor1-修改",
"protocol":"http",
"address":"//www.baidu.com",
"evalInterval":60,
"probePoint":[
"1"
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"taskID":"64ea1664-4347-558e-9bc6-651341c2fa15"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.SitemMonitorIDNotFound | 站點ID不存在 |
| Monitor.SiteMonitor.ProbePointNotAvailable | 探測點不可用 |
| 其他 | 參見公共錯誤碼說明 |
