撥測任務：創建
更新時間 2024-09-25 16:20:53
最近更新時間: 2024-09-25 16:20:53
分享文章
一次性撥測
撥測任務：創建
接口功能介紹
調用此接口可創建撥測任務。
接口約束
撥測地址，撥測任務類型，撥測點列表不為空，且撥測節點應可用。
URI
POST /v4/monitor/create-instant-detection-task
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| address | 是 | String | 目標撥測地 | www.daliqc.cn | |
| pointID | 是 | Array of Strings | 撥測點列表 | ['910c3625d5f0ebe505d44d4f257d6ae9'] | |
| type | 是 | String | 本參數表示撥測任務類型。取值范圍：http：http探測。ping：ping探測。mtr：mtr探測。traceroute：traceroute探測。根據以上范圍取值。 | http |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 | acd8b6b4610b97d202306301808 |
請求示例
請求url
/v4/monitor/create-instant-detection-task
請求頭header
無
請求體body
{
"address": "www.daliqc.cn",
"pointID": [
"910c3625d5f0ebe505d44d4f257d6ae9"
],
"type": "http"
}
響應示例
{
"statusCode": 800,
"returnObj": {
"taskID": "acd8b6b4610b97d202306301808"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
