文档

GetSyntheticTaskDetail - 获取定时拨测任务的详情

更新时间:

根据任务ID获取定时拨测任务的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。默认为 cn-hangzhou。

cn-hangzhou
TaskIdstring

云拨测任务 ID。

123

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

4D6C358A-A58B-4F4B-94CE-F5AAF023****
TaskDetailobject

任务详情。

TaskIdlong

云拨测任务 ID。

19584
TaskNamestring

任务名称。

net-test
Urlstring

拨测地址。

www.example.com
MonitorListobject []

检测点列表

CityCodelong

城市编码。

11011XX
NetServiceIdlong

网络服务 ID。

12
MonitorTypelong

监测点类型。

1
SendCountlong

发送次数。

2
TaskTypelong

任务类型:

  1. 3:网页性能-IE
  2. 34:网页性能-Chrome
  3. 0:网络质量
  4. 40:文件下载
  5. 7:API 性能
0
IntervalTimelong

拨测频率,单位为分钟。可选频率如下:

  • 1
  • 5
  • 10
  • 15
  • 20
  • 30
  • 60
  • 120
  • 180
  • 240
  • 360
  • 480
  • 720
  • 1440
20
IntervalTypelong

监测周期类型:

  • 0:每天
  • 1:自定义扩展频率
0
ExtendIntervalobject

自定义扩展频率。

StartTimestring

周期开始时间,格式 yyyy-MM-dd HH

2022-02-26 11:40
EndTimestring

周期结束时间 。格式为yyyy-MM-dd HH

2022-05-03 11:40
Daysarray

拨测执行周期。

  • -1:每天
  • 0:周日
  • 1:周一
  • 2:周二
  • 3:周三
  • 4:周四
  • 5:周五
  • 6:周六
long

拨测执行日期。

3
StartHourlong

当天开始拨测时间的小时数。

9
StartMinutelong

当天开始拨测时间的分钟数。

20
Endhourlong

当天结束小时数。

12
EndMinutelong

当天结束分钟数。

20
IpTypelong

IP 类型:

  • 0:自动
  • 1:IPv4
  • 2:IPpv6
0
Downloadobject

文件下载任务。

DownloadTransmissionSizelong

传输大小,单位为 KB。

20
DownloadCustomHostlong

自定义 Host。

  • 1:轮循
  • 0:随机
0
DownloadCustomHostIpstring

自定义 Host IP。可以填写多个 IP,每个 IP 用半角逗号(,)分隔。

168.23.45.1
WhiteListstring

DNS 劫持白名单。填写格式:域名:匹配规则

说明 WAP 网络不支持劫持。
[{\"src\":\"211.154.166.174\"}]
DownloadKernellong

下载内核。

  • 1:curl
  • 0:WinInet
1
QuickProtocolstring

Quick 协议

  • 1:http1
  • 2:http2
  • 3:http3
1
MonitorTimeoutlong

监测时长。

12
ConnectionTimeoutlong

下载任务超时时间

200
VerifyWaylong

验证响应内容。

  • 0:不验证
  • 1:字符串完全匹配
  • 2:字符串部分包含
  • 3:MD5 验证
0
ValidateKeywordsstring

验证关键词。

test
DownloadRedirectlong

是否支持重定向。

1
DownloadCustomHeaderContentstring

证书错误忽略内容。将复选框的值用竖线‘|’拼接传递。

char
Netobject

网络任务。

NetIcmpSwitchlong

Ping 监测开关。

  • 0:关
  • 1:开,当设置为 1 时还需设置 Icmp 参数。
0
NetIcmpActivelong

协议类型

  • 0 : ICMP
  • 1 : TCP
0
NetIcmpTimeoutlong

监测超时时间。

20
NetIcmpIntervallong

拨测任务执行间隔。

10
NetIcmpNumlong

Package 数量。

10
NetIcmpSizelong

Package 大小。

30
NetIcmpDataCutlong

切分 package 开关,取值:

  • 0: 关
  • 1: 开
0
NetDnsQueryMethodstring

DNS 查询方式,取值:

  • 1: 递归
  • 2: 迭代
1
NetDnsSwitchlong

DNS 监测开关,取值:

  • 0: 关
  • 1: 开
0
NetTraceRouteSwitchlong

Tracert 监测开关。

  • 0:关。
  • 1:开,开启后需设置 Tracert 参数。
0
NetTraceRouteTimeoutlong

监测超时,取值范围为 0~300 秒。

20
NetTraceRouteNumlong

最大活跃点数。

30
WhiteListstring

DNS 劫持白名单。填写格式:域名:匹配规则

说明 WAP 网络不支持劫持。
119.119.53.156/32
NetDnsNsstring

指定 NS 服务器。

189.12.32.124
NetDigSwitchlong

是否以 dig 数据格式展示数据内容。

  • 0:否
  • 1:是
0
NetDnsServerlong

DNS 服务器类型,取值:

  • 0: ipv4
  • 1: ipv6
  • 2: 自动
0
NetDnsTimeoutstring

网络 DNS 超时时间。

10
Navobject

浏览任务。

NavDisableCachelong

是否禁用缓存。

  • 1:禁用
  • 0:不禁用
1
NavReturnElementlong

是否返回页面的元素。

  • 1:否,返回基础文档数据。
  • 2:是,返回所有文档数据。
1
NavRedirectlong

重定向,取值:

  • 0: 否
  • 1: 是
1
NavDisableCompressionlong

禁用压缩,取值:

  • 0: 不禁用
  • 1: 禁用
0
NavAutomaticScrollinglong

是否支持自动滚动屏幕,加载页面。

  • 1:是
  • 0:否
1
NavIgnoreCertificateErrorlong

是否忽略在 SSL 握手中证书校验过程中的证书错误而继续浏览。

  • 1:忽略
  • 0:不忽略
1
FilterInvalidIPlong

是否过滤非有效 IP。

  • 1:不过滤
  • 0:过滤
1
ExecuteAppletlong

执行 Applet,取值:

  • 0: 不执行
  • 1: 执行
1
ExecuteActiveXlong

是否执行 ActiveX。

  • 3:执行
  • 0:不执行
说明 仅 IE 全元素支持此参数。
3
ExecuteScriptlong

是否执行脚本。

  • 1:执行
  • 0:不执行
说明 仅 IE 全元素支持此参数。
1
QuicVersionlong

quic 版本,默认 0。

  • 35:35
  • 39: 39
  • 43: 43
  • 44: 44
说明 仅 Chrome 全元素支持此参数。
0
QuicDomainstring

quic 请求元素域名。

www.example.com
RequestHeaderlong

返回请求头。

  • 0:不返回
  • 1:返回基础文档 Header
  • 2:返回所有的 Header
0
NavCustomHostlong

选择自定义 Host 模式。

  • 1:轮循
  • 0:随机
1
NavCustomHostIpstring

自定义 Host IP。可以填写多个 IP,每个 IP 用半角逗号(,)分隔。

119.119.53.156/32
NavCustomHeaderstring

自定义 header。

  • 0:关
  • 1:修改第一包
  • 2:修改全部包
0
NavCustomHeaderContentstring

自定义 Header 格式。可以填写多个字段,多个字段以竖线()隔开。

content
ElementBlackliststring

元素黑名单。

test
ProcessNamestring

进程标识。

ssh
VerifyStringBlackliststring

验证字符串黑名单。

test
VerifyStringWhiteliststring

验证字符串白名单。

test
MonitorTimeoutlong

监控超时时间。

20
WaitCompletionTimelong

等待完成时间。

20
SlowElementThresholdlong

慢元素阈值,单位为秒。

30
DnsHijackWhiteliststring

dns 白名单列表。

119.119.53.156
PageTamperingstring

页面篡改。

content
FlowHijackJumpTimeslong

识别元素。

12
Protocolobject

API 性能类型的拨测任务。

RequestContentobject

请求内容(包含 Header、Body)。

Methodstring

请求方法。

  • POST
  • GET
POST
Headerobject []

请求头。

Keystring

请求参数中 header 的 key

regionId
Valuestring

请求参数中 header 的值

cn-hangzhou
Bodyobject

请求 body 内容

Modestring

内容类型。

  • form-data
  • x-www-form-urlencoded
  • raw
form-data
Formdataobject

mode=form-data 时传入的数据内容。

Keystring

form-data的 Key。

appId
Valuestring

form-data 的 value。

3425
Urlencodedobject

Body 内容的 URLl 地址.

Keystring

Tag 的键。

appId
Valuestring

Tag 的值。

11080
Rawstring

Mode 设置为 raw 时传入的数据内容。

content
Languagestring

Mode 设置为 raw 时选择的语言。

  • json
  • xml
  • javascript
  • html
  • text
xml
CharacterEncodinglong

字符编码。

  • 0:utf-8
  • 1:gbk
  • 2:gb2312
  • 3:unicode
0
VerifyWaylong

验证响应内容。

  • 0:不验证
  • 1:字符串完全匹配
  • 2:字符串部分包含
  • 3:MD5 验证
0
VerifyContentstring

验证内容。

list
ReceivedDataSizelong

接收数据大小。验证响应内容选择部分包含时填写。

30
ProtocolMonitorTimeoutlong

监测超时时间,单位为秒。

30
ProtocolConnectionTimeoutlong

超时时间

20
CustomHostlong

自定义 Host。

  • 1:轮循
  • 0:随机
1
CustomHostIpstring

自定义 Host IP。可以填写多个 IP,每个 IP 用半角逗号(,)分隔。

119.119.53.156
MonitorListStringstring

监测点列表字符串。

12
CommonParamobject

通用参数列表。

AlarmFlaglong

告警标识符。

1
AlertPolicyIdstring

报警策略 ID。

1
AlertNotifierIdstring

报警标识符 ID。

1
StartExecutionTimestring

开始执行时间。

1664427128
MonitorSamplesstring

监测样本。

1
AlertListobject []

报警列表。

Namestring

报警名称。

alert-test
GeneralAlertstring

普通报警。

1
SeriousAlertstring

严重报警。

1
IsCriticalstring

是否是必要条件。

0
Symbolsstring

大于或小于。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "TaskDetail": {
    "TaskId": 19584,
    "TaskName": "net-test",
    "Url": "www.example.com",
    "MonitorList": [
      {
        "CityCode": 0,
        "NetServiceId": 12,
        "MonitorType": 1,
        "SendCount": 2
      }
    ],
    "TaskType": 0,
    "IntervalTime": 20,
    "IntervalType": 0,
    "ExtendInterval": {
      "StartTime": "2022-02-26 11:40",
      "EndTime": "2022-05-03 11:40",
      "Days": [
        3
      ],
      "StartHour": 9,
      "StartMinute": 20,
      "Endhour": 12,
      "EndMinute": 20
    },
    "IpType": 0,
    "Download": {
      "DownloadTransmissionSize": 20,
      "DownloadCustomHost": 0,
      "DownloadCustomHostIp": "168.23.45.1",
      "WhiteList": "[{\\\"src\\\":\\\"211.154.166.174\\\"}]",
      "DownloadKernel": 1,
      "QuickProtocol": "1",
      "MonitorTimeout": 12,
      "ConnectionTimeout": 200,
      "VerifyWay": 0,
      "ValidateKeywords": "test",
      "DownloadRedirect": 1,
      "DownloadCustomHeaderContent": "char"
    },
    "Net": {
      "NetIcmpSwitch": 0,
      "NetIcmpActive": 0,
      "NetIcmpTimeout": 20,
      "NetIcmpInterval": 10,
      "NetIcmpNum": 10,
      "NetIcmpSize": 30,
      "NetIcmpDataCut": 0,
      "NetDnsQueryMethod": "1",
      "NetDnsSwitch": 0,
      "NetTraceRouteSwitch": 0,
      "NetTraceRouteTimeout": 20,
      "NetTraceRouteNum": 30,
      "WhiteList": "119.119.53.156/32",
      "NetDnsNs": "189.12.32.124",
      "NetDigSwitch": 0,
      "NetDnsServer": 0,
      "NetDnsTimeout": "10"
    },
    "Nav": {
      "NavDisableCache": 1,
      "NavReturnElement": 1,
      "NavRedirect": 1,
      "NavDisableCompression": 0,
      "NavAutomaticScrolling": 1,
      "NavIgnoreCertificateError": 1,
      "FilterInvalidIP": 1,
      "ExecuteApplet": 1,
      "ExecuteActiveX": 3,
      "ExecuteScript": 1,
      "QuicVersion": 0,
      "QuicDomain": "www.example.com",
      "RequestHeader": 0,
      "NavCustomHost": 1,
      "NavCustomHostIp": "119.119.53.156/32",
      "NavCustomHeader": "0",
      "NavCustomHeaderContent": "content",
      "ElementBlacklist": "test",
      "ProcessName": "ssh",
      "VerifyStringBlacklist": "test",
      "VerifyStringWhitelist": "test",
      "MonitorTimeout": 20,
      "WaitCompletionTime": 20,
      "SlowElementThreshold": 30,
      "DnsHijackWhitelist": "119.119.53.156",
      "PageTampering": "content",
      "FlowHijackJumpTimes": 12,
      "FlowHijackLogo": "target"
    },
    "Protocol": {
      "RequestContent": {
        "Method": "POST",
        "Header": [
          {
            "Key": "regionId",
            "Value": "cn-hangzhou"
          }
        ],
        "Body": {
          "Mode": "form-data",
          "Formdata": {
            "Key": "appId",
            "Value": "3425"
          },
          "Urlencoded": {
            "Key": "appId",
            "Value": "11080"
          },
          "Raw": "content",
          "Language": "xml"
        }
      },
      "CharacterEncoding": 0,
      "VerifyWay": 0,
      "VerifyContent": "list",
      "ReceivedDataSize": 30,
      "ProtocolMonitorTimeout": 30,
      "ProtocolConnectionTimeout": 20,
      "CustomHost": 1,
      "CustomHostIp": "119.119.53.156"
    },
    "MonitorListString": "12",
    "CommonParam": {
      "AlarmFlag": 1,
      "AlertPolicyId": "1",
      "AlertNotifierId": "1",
      "StartExecutionTime": "1664427128",
      "MonitorSamples": "1",
      "AlertList": [
        {
          "Name": "alert-test",
          "GeneralAlert": "1",
          "SeriousAlert": "1",
          "IsCritical": "0",
          "Symbols": "1"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-09-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈