一次性撥測

撥測任務：查詢結果

接口功能介紹

調用此接口可查詢撥測任務結果。

接口約束

任務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.daliqc.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.daliqc.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	任務已過期
其他	參見公共錯誤碼說明