You need to enable JavaScript to run this app.
文档中心
云拨测

云拨测

复制全文
下载 pdf
拨测任务(V1)
GetTaskResult - 获取周期拨测任务结果
复制全文
下载 pdf
GetTaskResult - 获取周期拨测任务结果
调用 GetTaskResult 接口,查看周期拨测任务的执行结果。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetTaskResult​
要执行的操作,取值:GetTaskResult。​
​
Version string 必选 示例值:2023-08-31​
API的版本,取值:2023-08-31。​
​
TaskID long 必选 示例值:23309791​
任务ID。​
​
ProjectName string 可选 示例值:default​
项目名称​
​
StartTime long 必选 示例值:1672531200​
查询开始的时间。​
​
EndTime long 必选 示例值:1672531300​
查询结束时间(时间范围在1小时内)。​
​
PageNum long 必选 示例值:1​
请求的页码。​
​
PageSize long 必选 示例值:20​
每页显示的结果数量,最大值为500。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Data object[] 示例值:--​
表示任务结果的数据列表。​
TaskID long 示例值:23309791​
任务ID。​
​
BasicDetail object 示例值:--​
任务的基础信息,如节点信息、目标信息、可用性信息等。​
ClientInfo object 示例值:--​
节点信息。​
Region string 示例值:中国-北京​
节点所在的地区,可以是国内省份或海外国家。​
​
City string 示例值:北京​
节点所在的城市。​
​
Isp string 示例值:联通​
节点的互联网服务提供商。​
​
IP string 示例值:192.168.1.1​
节点的IPv4地址。​
​
DNSLocalDNSIP string 示例值:8.8.8.8.8​
拨测点的DNS配置信息,即节点使用的本地DNS服务器的IP地址。​
​
Ipv6 string 示例值:2001:0db8:abcd:ef0:xxxxx:5678:9abc​
节点的IPv6地址。​
​
Type string 示例值:2​
节点类型,取值:​
  • 1:LastMile节点。​
  • 2:IDC节点。​
  • 4:私有节点。​
​
​
TargetInfo object 示例值:--​
周期拨测任务的目标信息。​
DetectURL string 示例值:http://example.com​
被检测的目标地址。​
​
City string 示例值:北京​
目标所在的城市。​
​
Region string 示例值:中国-北京​
目标所在的地区,可以是国内省份或海外国家。​
​
Isp string 示例值:联通​
目标的互联网服务提供商。​
​
IP string 示例值:192.168.1.1​
目标的IPv4地址。​
​
Ipv6 string 示例值:2001:0db8:abcd:ef0:xxxx:5678:9abc​
目标的IPv6地址。​
​
​
UsabilityInfo object 示例值:--​
任务的可用性信息。​
Status string 示例值:success​
任务的执行状态:​
  • success:任务成功执行。​
  • fail:任务执行失败。​
​
Reason string[] 示例值:[]​
任务失败的具体原因,一个失败原因为一个元素。​
​
​
Timestamp long 示例值:1672531200​
数据时间。​
​
Assertions object[] 示例值:--​
断言结果信息。​
ConditionMessage string 示例值:--​
条件信息,即任务执行时需要满足的条件或标准。​
​
ResultValue string 示例值:180​
实际值,即任务执行后得到的结果数据。​
​
Success boolean 示例值:success​
任务是否执行成功:​
  • true:任务成功执行。​
  • false:任务执行失败。​
​
​
ErrorMsg string 示例值:""​
表示错误信息,如果任务执行失败,这里会提供失败的原因。​
​
ChUk string 示例值:abc123​
表示数据唯一键,用于标识特定的数据记录。​
​
DNSServer string 示例值:--​
DNS服务器​
​
​
PingDetail object 示例值:--​
网络质量详情。​
PingMinCost long 示例值:10​
PING测试中记录的最小延迟时间。​
​
PingAvgCost long 示例值:20​
PING测试中记录的平均延迟时间。​
​
PingMaxCost long 示例值:30​
PING测试中记录的最大延迟时间。​
​
PingLossRate double 示例值:0.05​
PING测试中的丢包率。​
​
PingDetail string 示例值:All packets received, no packet loss.​
提供PING测试的详细描述或额外信息。​
​
PingSendTimes long 示例值:5​
在PING测试中发送的数据包数量。​
​
PingReceiveTimes long 示例值:5​
在PING测试中接收到的数据包数量。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
PcapURI string 示例值:http://example.com/diagnostic-report​
下载链接,可用于获取更详细的诊断报告。​
​
DNSCost long 示例值:120​
DNS解析所花费的时间。​
​
MtrHops long 示例值:15​
MTR诊断过程中经过的跃点数。​
​
ResolveCost long 示例值:150​
整个DNS解析过程所花费的时间。​
​
​
HTTPDetail object 示例值:--​
HTTP请求的详细信息。​
TotalCost long 示例值:500​
整个HTTP请求的总时延。​
​
RedirectCost long 示例值:50​
HTTP请求中重定向操作的总时延。​
​
RedirectNums long 示例值:1​
HTTP请求中重定向的次数。​
​
DNSCost long 示例值:120​
DNS解析所花费的时间。​
​
TCPCost long 示例值:100​
TCP连接建立所花费的时间。​
​
SslCost long 示例值:30​
SSL握手所花费的时间。​
​
SendCost long 示例值:150​
发送请求所花费的时间。​
​
TtfbCost long 示例值:50​
第一个数据包(首包)发送所花费的时间。​
​
RecvCost long 示例值:200​
接收响应所花费的时间。​
​
HTTPCode long 示例值:200​
HTTP响应状态码。​
​
HTTPRequestHeader string 示例值:GET / HTTP/1.1​
HTTP请求的头部信息。​
​
HTTPResponseHeader string 示例值:Content-Type: text/html​
HTTP响应的头部信息。​
​
HTTPResponseBody string 示例值:<html>Example Page</html>​
HTTP响应的主体内容。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
LocationDetail object[] 示例值:--​
用于提供重定向的详细信息。​
URL string 示例值:http://newlocation.com​
重定向的目标URL。​
​
RemoteAddress string 示例值:192.0.2.1​
远程服务器的地址。​
​
StatusCode integer 示例值:301​
服务器响应的状态码。​
​
RequestHeaders object[] 示例值:--​
请求头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
ResponseHeaders object[] 示例值:--​
响应头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
TimeDNS double 示例值:120​
DNS查询所花费的时间,单位为毫秒(ms)。​
​
TimeTCP double 示例值:100​
TCP连接建立所花费的时间,单位为毫秒(ms)。​
​
TimeSsl double 示例值:150​
SSL握手所花费的时间,单位为毫秒(ms)。​
​
TimeWait double 示例值:200​
等待服务器响应所花费的时间,单位为毫秒(ms)。​
​
TimeReceive double 示例值:250​
从服务器接收数据所花费的时间,单位为毫秒(ms)。​
​
TimeTotal double 示例值:1000​
整个请求周期所花费的总时间,单位为毫秒(ms)。​
​
​
HTTPVersion string 示例值:HTTP/1.1​
HTTP版本,可选值:​
  • HTTP/1.1​
  • HTTP/2.0​
  • HTTP/3.0​
​
DownloadSize long 示例值:2097152​
下载的数据大小。​
​
DownloadSpeed long 示例值:1024000​
下载速度。​
​
​
DNSDetail object 示例值:--​
DNS的详细信息。​
DNSCost long 示例值:120​
表示DNS查询的耗时,单位为毫秒(ms)。​
​
ARecord string[] 示例值:["93.xxx.xxx.34"]​
A记录。​
​
AaaaRecord string[] 示例值:["2001:0db8:85a3:0000:0000:8a2e:0370:7334"]​
AAAA记录。​
​
CnameRecord string[] 示例值:["www.example.com"]​
CNAME记录。​
​
Detail string 示例值:DNS query successful, no errors.​
额外的详细信息。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
RecordCount integer 示例值:100​
记录的数量。​
​
Records string[] 示例值:-​
全部解析记录。​
​
​
TCPDetail object 示例值:--​
TCP连接的详细信息。​
TCPTimeTotal long 示例值:450​
整个TCP连接和数据传输过程的总耗时。单位:毫秒(ms)。​
​
TCPTimeDNS long 示例值:80​
TCP连接过程中DNS解析的耗时。单位:毫秒(ms)。​
​
TCPTimeConnect long 示例值:120​
建立TCP连接所需的时间。单位:毫秒(ms)。​
​
TCPTimeResponse long 示例值:100​
从客户端发送请求到服务器开始响应所需的时间。单位:毫秒(ms)。​
​
TCPTimeReceive long 示例值:140​
从开始接收数据到接收完成所需的时间。单位:毫秒(ms)。​
​
TCPResponse string 示例值:HTTP/1.1 200 OK​
TCP连接的响应体内容。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
​
UDPDetail object 示例值:--​
UDP通信的详细信息。​
UDPTimeTotal long 示例值:200​
整个UDP通信过程的总耗时。​
​
UDPTimeDNS long 示例值:50​
UDP通信过程中DNS解析的耗时。​
​
UDPTimeWait long 示例值:100​
等待UDP服务器响应的时间。​
​
UDPTimeReceive long 示例值:150​
接收UDP数据包所需的时间。​
​
UDPResponse string 示例值:Data received​
UDP通信的响应体内容。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
​
UploadDetail object 示例值:--​
上传操作的详细信息。​
UploadSpeed long 示例值:1024000​
上传速度。​
​
UploadSize long 示例值:1048576​
上传的数据大小。​
​
SendCost long 示例值:5000​
发送时间或上传时间。​
​
RedirectNums long 示例值:1​
重定向次数。​
​
HTTPCode long 示例值:200​
HTTP状态码。​
​
TotalCost long 示例值:2000​
总时延。​
​
DNSCost long 示例值:100​
DNS解析耗时。​
​
TCPCost long 示例值:200​
TCP连接建立耗时。​
​
SslCost long 示例值:300​
SSL/TLS握手耗时。​
​
TtfbCost long 示例值:400​
首包时间。​
​
RecvCost long 示例值:3000​
下载时间。​
​
HTTPRequestHeader string 示例值:GET /index.html HTTP/1.1\r\nHost: example.com​
HTTP请求头信息。​
​
HTTPResponseHeader string 示例值:HTTP/1.1 200 OK\r\nContent-Type: text/html​
HTTP响应头信息。​
​
HTTPResponseBody string 示例值:<html><body>Hello, World!</body></html>​
HTTP响应体。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
PcapURI string 示例值:http://example.com/packet_capture.pcap​
提供一个下载链接,可用于获取数据包。​
​
DownloadSpeed long 示例值:1024000​
下载速度。​
​
DownloadSize long 示例值:2097152​
下载的数据大小。​
​
RedirectCost long 示例值:200​
重定向时间。​
​
UploadTime long 示例值:2000​
上传时间。​
​
LocationDetail object[] 示例值:--​
重定向的详细信息。​
URL string 示例值:http://newlocation.com​
重定向的目标URL。​
​
RemoteAddress string 示例值:192.0.2.1​
远程服务器的地址。​
​
StatusCode integer 示例值:301​
服务器响应的状态码。​
​
RequestHeaders object[] 示例值:--​
请求头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
ResponseHeaders object[] 示例值:--​
响应头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
TimeDNS double 示例值:120​
DNS查询所花费的时间,单位为毫秒(ms)。​
​
TimeTCP double 示例值:100​
TCP连接建立所花费的时间,单位为毫秒(ms)。​
​
TimeSsl double 示例值:150​
SSL握手所花费的时间,单位为毫秒(ms)。​
​
TimeWait double 示例值:200​
等待服务器响应所花费的时间,单位为毫秒(ms)。​
​
TimeReceive double 示例值:250​
从服务器接收数据所花费的时间,单位为毫秒(ms)。​
​
TimeTotal double 示例值:1000​
整个请求周期所花费的总时间,单位为毫秒(ms)。​
​
​
HTTPVersion string 示例值:HTTP/1.1​
HTTP版本:​
  • HTTP/1.1​
  • HTTP/2.0​
  • HTTP/3.0​
​
​
DownloadDetail object 示例值:--​
下载操作的详细信息。​
DownloadSpeed long 示例值:1024000​
下载速度。​
​
DownloadSize long 示例值:1048576​
下载的数据大小。​
​
RecvCost long 示例值:5000​
下载时间。​
​
RedirectNums long 示例值:1​
重定向次数。​
​
HTTPCode long 示例值:200​
HTTP状态码。​
​
TotalCost long 示例值:2000​
总时延。​
​
DNSCost long 示例值:100​
DNS解析耗时。​
​
TCPCost long 示例值:150​
TCP连接建立耗时。​
​
SslCost long 示例值:200​
SSL/TLS握手耗时。​
​
SendCost long 示例值:50​
发送时间。​
​
TtfbCost long 示例值:300​
首包时间。​
​
HTTPRequestHeader string 示例值:GET /index.html HTTP/1.1\r\nHost: example.com​
HTTP请求头信息。​
​
HTTPResponseHeader string 示例值:HTTP/1.1 200 OK\r\nContent-Type: text/html​
HTTP响应头信息。​
​
HTTPResponseBody string 示例值:<html><body>Hello, World!</body></html>​
HTTP响应体内容。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
PcapURI string 示例值:http://example.com/packet_capture.pcap​
提供一个下载链接,可用于获取数据包。​
​
UploadSpeed long 示例值:1024000​
上传速度。​
​
UploadSize long 示例值:1048576​
上传的数据大小。​
​
RedirectCost long 示例值:200​
重定向时间。​
​
UploadTime long 示例值:2000​
上传时间。​
​
LocationDetail object[] 示例值:--​
重定向的详细信息。​
URL string 示例值:http://newlocation.com​
重定向的目标URL。​
​
RemoteAddress string 示例值:192.0.2.1​
远程服务器的地址。​
​
StatusCode integer 示例值:301​
服务器响应的状态码。​
​
RequestHeaders object[] 示例值:--​
请求头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
ResponseHeaders object[] 示例值:--​
响应头信息。​
Key string 示例值:User-Agent​
表示请求头部的键。​
​
Value string 示例值:Mozilla/5.0 (Windows NT 10.0; Win64; x64)​
表示请求头部的值。​
​
​
TimeDNS double 示例值:120​
DNS查询所花费的时间,单位为毫秒(ms)。​
​
TimeTCP double 示例值:100​
TCP连接建立所花费的时间,单位为毫秒(ms)。​
​
TimeSsl double 示例值:150​
SSL握手所花费的时间,单位为毫秒(ms)。​
​
TimeWait double 示例值:200​
等待服务器响应所花费的时间,单位为毫秒(ms)。​
​
TimeReceive double 示例值:250​
从服务器接收数据所花费的时间,单位为毫秒(ms)。​
​
TimeTotal double 示例值:1000​
整个请求周期所花费的总时间,单位为毫秒(ms)。​
​
​
HTTPVersion string 示例值:HTTP/1.1​
HTTP版本:​
  • HTTP/1.1​
  • HTTP/2.0​
  • HTTP/3.0​
​
​
PageDetail object 示例值:--​
页面元素的详细信息。​
PageTimeTotal long 示例值:5000​
页面完全加载时间。单位:毫秒(ms)。​
​
PageTimeFirstScreen long 示例值:2000​
页面DOM加载时间。单位:毫秒(ms)。​
​
PageCountElement long 示例值:200​
页面元素个数。​
​
PageCountErrorElement long 示例值:5​
页面错误元素个数。​
​
PageErrorElementProportion long 示例值:--​
页面错误元素个数。​
说明​
该字段已废弃。​
​
PageElementSpeedAvg long 示例值:--​
页面元素加载速度。​
说明​
该字段已废弃。​
​
PageDownloadBytesTotal long 示例值:1048576​
页面元素总大小。单位:毫秒(ms)。​
​
HTTPRequestHeader string 示例值:GET /index.html HTTP/1.1\r\nHost: example.com​
HTTP请求头信息。​
​
HTTPResponseHeader string 示例值:HTTP/1.1 200 OK\r\nContent-Type: text/html​
HTTP响应头信息。​
​
DiagnoseDetail object 示例值:--​
网络诊断的详细信息。​
DNSDetail string 示例值:DNS resolution successful.​
DNS诊断的详细信息。​
​
MtrDetail string 示例值:MTR completed with 15 hops.​
MTR诊断的详细信息。​
​
PingDetail string 示例值:PING successful with 5ms average latency.​
PING诊断的详细信息。​
​
​
PageRequestID string 示例值:req123​
页面元素ID。​
​
PageErrorElemProportion double 示例值:0.05​
错误元素占比。​
​
PageElemSpeedAvg double 示例值:250​
页面元素加载速度。​
​
​
​
Pagination object 示例值:--​
分页信息。​
PageNum long 示例值:1​
当前页码。​
​
PageSize long 示例值:20​
每页的数据条数。​
​
Total long 示例值:100​
总数据条数。​
​
​
​
​
请求示例​
​
POST https://cloud-detect.volcengineapi.com?Action=GetTaskResult&Version=2023-08-31​
{​
"TaskID": 23309791,​
"StartTime": 1735019516,​
"EndTime": 1735021256,​
"PageNum": 1,​
"PageSize": 100​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202412241000447C22CC9717E13348****",​
"Action": "GetTaskResult",​
"Version": "2023-08-31",​
"Service": "cloud_detect",​
"Region": "cn-north-1"​
},​
"Result": {​
"BaseResponse": {​
"Extra": null,​
"Logid": "",​
"ShowMessage": "",​
"StatusCode": 0,​
"StatusMessage": ""​
},​
"Data": [],​
"Pagination": {​
"PageNum": 1,​
"PageSize": 100,​
"Total": 0​
}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
AccessDenied​
User is not authorized to perform: cloud_detect:{Action} on resource:​
无权限进行此操作及对应资源​
400​
Bad Request​
invalid request​
无效的请求。​
​
​
最近更新时间:2025.09.19 12:01:46
这个页面对您有帮助吗?
有用
有用
无用
无用