一次性拨测

拨测任务：查询结果

接口功能介绍

调用此接口可查询拨测任务结果。

接口约束

任务ID，拨测类型不为空。

URI

POST /v4/monitor/query-instant-detection-task

路径参数

无

Query参数

无

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
taskID	是	String	任务ID	acd8b6b4610b97d202306301808
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

参数	参数类型	说明	示例	下级对象
data	Object	返回结果		dataObj
status	Integer	本参数表示任务状态码，取值范围：1：运行中。2：已完成。 3：失败。 4：过期。根据以上范围取值。	2
type	String	本参数表示拨测任务类型。取值范围：http：http探测。ping：ping探测。mtr：mtr探测。traceroute：traceroute探测。根据以上范围取值。	http
duration	Integer	任务耗时，单位ms	500
createTime	Integer	创建时间，毫秒级时间戳	1688119722000

表 dataObj

参数	参数类型	说明	示例	下级对象
pingData	Array of Objects	ping探测的返回值		pingDataObj
httpData	Array of Objects	http探测的返回值		httpDataObj
mtrData	Array of Objects	mtr探测的返回值		mtrDataObj
tracerouteData	Array of Objects	traceroute探测的返回值		tracerouteDataObj

表 pingDataObj

参数	参数类型	说明	示例	下级对象
targetIP	String	目标IP	203.0.113.1
status	Integer	拨测状态	200
packetLoss	Double	丢包率	2.5
maxTime	Double	最大时间	452
minTime	Double	最小时间	202
avgTime	Double	平均时间	326
detail	String	详情	PING www.ctyun.cn (36.250.144.27): 56 data bytes
pointID	String	拨测点ID	910c3625d5f0ebe505d44d4f257d6ae9

表 httpDataObj

参数	参数类型	说明	示例	下级对象
targetIP	String	目标IP	203.0.113.1
status	Integer	拨测状态	200
totalTime	Double	总时间（毫秒）	20
totalDownloadSize	Double	总下载大小（KB）	60
detail	String	详情	HTTP/1.1 200 OK X-Permitted-Cross-Domain-Policies: none
pointID	String	拨测点ID	910c3625d5f0ebe505d44d4f257d6ae9

表 mtrDataObj

参数	参数类型	说明	示例	下级对象
info	Array of Objects	结构化数据		mtrInfoObj
targetIP	String	目标IP	203.0.113.1
detail	String	详情	2 172.16.254.245 0.0% 5 0.91 0.90 0.84 1.02
pointID	String	拨测点ID	910c3625d5f0ebe505d44d4f257d6ae9

表 mtrInfoObj

参数	参数类型	说明	示例	下级对象
sequence	Integer	序号	4
host	String	主机名称	221.183.41.26
packetLossRate	Double	丢包率（百分比）	80
packetCount	Double	数据包量	5
latestProbeTime	Double	最近一次探测用时（毫秒）	20.1
averageTime	Double	平均时间（毫秒）	19.5
minTime	Double	最小时间（毫秒）	15.2
maxTime	Double	最大时间（毫秒）	33.2
standardDeviation	Integer	标准偏差	0

表 tracerouteDataObj

参数	参数类型	说明	示例	下级对象
info	Array of Objects	结构化数据		tracerouteInfoObj
targetIP	String	目标IP	203.0.113.1
detail	String	详情	"rtt":1,"ip":"183.232.251.77"
pointID	String	拨测点ID	910c3625d5f0ebe505d44d4f257d6ae9

表 tracerouteInfoObj

参数	参数类型	说明	示例	下级对象
sequence	Integer	序号	4
host	String	主机名称	221.183.41.26
totalTime	Double	总时间（毫秒）	15.2

请求示例

请求url

/v4/monitor/query-instant-detection-task

请求头header

无

请求体body

{
  "type": "http",
  "taskID": "acd8b6b4610b97d202306301808"
}

响应示例

{
    "statusCode":800,
    "returnObj":{
        "data":{
            "pingData":[
                {
                    "targetIP":"203.0.113.1",
                    "status":200,
                    "packetLoss":2.5,
                    "maxTime":452,
                    "minTime":202,
                    "avgTime":326,
                    "detail":"PING www.ctyun.cn (36.250.144.27): 56 data bytes",
                    "pointID":"910c3625d5f0ebe505d44d4f257d6ae9"
                }
            ],
            "httpData":[],
            "mtrData":[],
            "tracerouteData":[]
        },
        "status":2,
        "type":"ping",
        "duration":500,
        "createTime":1688119722000
    },
    "errorCode":"",
    "message":"Success",
    "msgDesc":"成功"
}

状态码

状态码	描述
200	请求成功

错误码

errorCode	描述
Monitor.InstantDetection.CreateListenerFailed	创建监听数据包的网络连接失败
Monitor.InstantDetection.WriteToFailed	写入网络连接错误
Monitor.InstantDetection.ReadFromFailed	从连接中读取错误
Monitor.InstantDetection.TraceRouteFailed	路由追踪失败
Monitor.InstantDetection.InvalidResponseError	无效相应
Monitor.InstantDetection.HttpTimeoutError	Http请求超时未响应
Monitor.InstantDetection.DnsLookupFailed	DNS查找失败
Monitor.InstantDetection.ReturnIpFailed	返回IP地址失败
Monitor.InstantDetection.NetworkOperationFailed	网络操作失败
Monitor.InstantDetection.TaskExpirationError	任务已过期
其他	参见公共错误码说明