一次性拨测
拨测任务：创建
接口功能介绍
调用此接口可创建拨测任务。
接口约束
拨测地址，拨测任务类型，拨测点列表不为空，且拨测节点应可用。
URI
POST /v4/monitor/create-instant-detection-task
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| address | 是 | String | 目标拨测地 | www.ctyun.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.ctyun.cn",
"pointID": [
"910c3625d5f0ebe505d44d4f257d6ae9"
],
"type": "http"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"taskID": "acd8b6b4610b97d202306301808"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
