GetTimingSyntheticTask - 获取拨测任务详情

获取任务详情。

接口说明

云拨测目前仅在杭州 region 提供服务,使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:GetTimingSyntheticTaskget
  • SyntheticTask
    acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}

请求参数

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

地域 ID。

cn-hangzhou
TaskIdstring

云拨测任务 ID。

856566a9cb2a4cafa05aa95ed0*******

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id

E13430A6-57A9-56E9-9D8D-28FE8DEBCA40
Codelong

状态码。说明 200 表示成功。

200
Messagestring

返回信息。

success
Dataobject

返回结构体。

TaskIdstring

云拨测任务 ID。

5308a2691f59422c8c3b7aeccec9cd3b
RegionIdstring

区域 ID

cn-hangzhou
Namestring

拨测任务名称

拨测任务
TaskTypeinteger

任务类型:

  • 1:ICMP
  • 2:TCP
  • 3:DNS
  • 4:HTTP
  • 5:网站测速
  • 6:文件下载
5
MonitorConfobject

任务配置

NetICMPobject

ICMP 拨测配置参数。当 TaskType 为 1 时必填。

TargetUrlstring

拨测目标地址(主机)。只能是域名或者 IP 地址。

www.aliyun.com
Intervalinteger

建立 TCP 连接的时间间隔。单位为毫秒(ms),最小值为 200,最大值为 10000,默认为 200。

200
PackageNuminteger

发送 ICMP(Ping)数据包的数量。最小值为 1,最大值为 50,默认为 4。

4
PackageSizeinteger

发送 ICMP(Ping)数据包的大小。单位为 byte,允许设置为 32, 64, 128, 256, 512, 1024。

1024
SplitPackageboolean

是否拆分 ICMP(Ping)数据包。默认为 true。

true
Timeoutlong

超时时间,单位 ms,默认 20000,范围 1000~300000。

2000
TracertEnableboolean

是否开启 tracert。默认为 true。

true
TracertNumMaxinteger

tracert 的最大跃点数。最小值为 1,最大值为 128,默认为 64。

64
TracertTimeoutlong

tracert 的超时时间。单位为毫秒(ms),最小值为 1000,最大值为 300000,默认为 60000。

60000
NetTCPobject

TCP 拨测的配置参数。当 TaskType 为 2 时必填。

TargetUrlstring

拨测目标地址。

127.0.0.1:8888
ConnectTimesinteger

单次拨测建立连接的次数,1~16 之间,默认 4。

4
Intervallong

建立 TCP 连接的时间间隔。单位为毫秒(ms),最小值为 200,最大值为 10000,默认为 200。

200
Timeoutlong

TCP 拨测超时时间。单位为毫秒(ms),最小值为 1000,最大值为 300000,默认为 20000。

20000
TracertEnableboolean

是否开启 tracert。默认为 true。

true
TracertNumMaxinteger

tracert 的最大跃点数。最小值为 1,最大值为 128,默认为 20。

20
TracertTimeoutlong

tracert 的超时时间。单位为毫秒(ms),最小值为 1000,最大值为 300000,默认为 60000。

60000
NetDNSobject

DNS 拨测的配置参数。当 TaskType 为 3 时必填。

TargetUrlstring

拨测域名。

www.aliyun.com
DnsServerIpTypeinteger

DNS 服务器 IP 类型。

  • 0(默认):ipv4
  • 1:ipv6
  • 2: 自动
0
NsServerstring

NS 服务器 IP,默认 114.114.114.114。

114.114.114.114
QueryMethodinteger

DNS 查询方式,0: 递归, 1:迭代。

0
Timeoutlong

DNS 拨测超时时间。单位为毫秒(ms),最小值为 1000,最大值为 45000,默认为 5000。

5000
ApiHTTPobject

HTTP(S)类型任务配置信息。

TargetUrlstring

拨测地址。

http://127.0.0.1:8090/api/list
Methodstring

请求方法。

  • POST
  • GET
POST
RequestHeadersobject

HTTP 请求头。

string

JSON Map 类型字符串。

{ "key1": "value1", "key2": "value2" }
RequestBodyobject

HTTP 请求体。

Contentstring

请求体内容,为 JSON 字符串格式。当 type 为 text/plain,application/json,application/xml,text/html,content 内容转为 JSON 字符串即可。

text/plain
Typestring

请求体类型,支持:text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html。

multipart/form-data
ConnectTimeoutlong

连接超时, ms,默认 5000,范围为 1000~300000ms。

5000
Timeoutlong

超时时间,ms,默认 10000,范围为 1000~300000ms。

10000
CheckCertboolean

是否校验证书,默认为否。

false
ProtocolAlpnProtocolinteger

ALPN 协议版本(wap 移动端并且是 HTTPS 任务时可配置):

0-default 系统默认行为

1-http/1.1

2-h2

3-off 关闭,不启用 alpn_protocol

1
FileDownloadobject

文件下载类型任务配置。

TargetUrlstring

下载链接。

https://********
DownloadKernellong

下载内核。

  • 1:curl
  • 0:WinInet
0
QuickProtocollong

Quick 协议

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

连接超时。文件下载的连接超时必须在 1000~120000ms 之间,默认 5000。

5000
CustomHeaderContentobject

自定义请求头内容,JSON Map。

string

JSON Map。

{ "key1": "value1", "key2": "value2" }
IgnoreCertificateStatusErrorinteger

证书状态错误忽略。

  • 0:不忽略
  • 1(默认):忽略
0
IgnoreCertificateUntrustworthyErrorinteger

证书不可信忽略。

  • 0:不忽略
  • 1(默认):忽略
0
IgnoreInvalidHostErrorinteger

主机无效错误忽略。

  • 0:不忽略
  • 1(默认):忽略
0
MonitorTimeoutlong

监测超时时间,ms,默认 60000,范围 1000~120000ms 之间。

6000
Redirectioninteger

是否支持重定向。

  • 0:不支持
  • 1(默认):支持
0
TransmissionSizelong

传输大小,KB,默认 2048KB,文件下载的传输大小必须在 1~20480KB 之间。

2048
IgnoreCertificateCanceledErrorinteger

忽略证书撤销错误。

  • 0:不忽略
  • 1(默认):忽略
0
IgnoreCertificateAuthErrorinteger

忽略 CA 证书授权错误。

  • 0:不忽略
  • 1(默认):忽略
0
IgnoreCertificateOutOfDateErrorinteger

忽略证书过期错误。

  • 0:不忽略
  • 1(默认):忽略
0
IgnoreCertificateUsingErrorinteger

忽略证书使用错误。

  • 0:不忽略
  • 1(默认):忽略
0
VerifyWayinteger

验证方式。

  • 0:不验证
  • 1:验证字符串
  • 2:MD5 验证
0
ValidateKeywordsstring

验证关键词。

success
WhiteListstring

DNS 劫持白名单。匹配规则支持 IP、IP 通配符、子网掩码和 CNAME,可以填写多个匹配规则,多个匹配规则以竖线(|)隔开。例如:www.aliyun.com:203.0.3.55|203.3.44.67,表示 www.aliyun.com 域名下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。

www.aliyun.com:203.0.3.55|203.3.44.67
Websiteobject

网站测速类型任务配置。

TargetUrlstring

目标网址。

http://www.aliyun.com
AutomaticScrollinginteger

是否支持自动滚动屏幕,加载页面。0-否,1-是,默认为 0。

0
CustomHeaderinteger

自定义 header。

  • 0:关(默认)
  • 1:修改第一包
  • 2:修改全部包
0
CustomHeaderContentobject

自定义 header,JSON Map 格式。

string

JSON Map

{ "key1": "value1", "key2": "value2" }
DisableCacheinteger

是否禁用缓存。

  • 0:不禁用
  • 1(默认):禁用
1
DisableCompressioninteger

通过 Accept-Encoding 字段判断是否接受压缩文件,0-不禁用,1-禁用,默认为 0。

0
FilterInvalidIPinteger

是否过滤非有效 IP。

  • 1:不过滤
  • 0:过滤
0
IgnoreCertificateErrorinteger

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

  • 0:不忽略
  • 1(默认):忽略
0
MonitorTimeoutinteger

监测超时,单位为 ms。非必填,默认 20000。 范围为 5000~300000ms。

20000
Redirectioninteger

当出现重定向后,是否要继续浏览。

  • 0:否
  • 1(默认):是
1
SlowElementThresholdlong

慢元素阈值,单位为 ms,默认 5000,范围为 1~300000ms。

5000
WaitCompletionTimelong

最大等待完成时间,单位为 ms,默认 5000,范围为 5000~300000ms。

5000
VerifyStringBlackliststring

验证字符串即监测页面源代码中的某个任意字符串。若客户端返回的源码中包含任一黑名单中的字符串则报 650 验证字符串失败的错误。多个字符串以竖线(|)隔开。

error
VerifyStringWhiteliststring

验证字符串即监测页面源代码中的某个任意字符串。客户端返回的源码必须包含所有白名单中的字符串,否则报 650 验证字符串失败的错误。多个字符串以竖线(|)隔开。

success
ElementBlackliststring

在页面加载过程中如果出现元素黑名单中配置的元素,不会请求加载该元素 。

www.example.com/a.jpg
DNSHijackWhiteliststring

域名(例如 www.aliyun.com)解析时,解析出的 IP 地址或者 CNAME 不在 DNS 劫持白名单内,用户就会访问失败或者返回一个非 Aliyun 的目标 IP;若解析结果中的 IP 或者 CNAME 在 DNS 白名单内,则会被认定为没有发生 DNS 劫持。

填写格式:域名:匹配规则。匹配规则支持 IP、IP 通配符、子网掩码和 CNAME,可以填写多个匹配规则,多个匹配规则以竖线(|)隔开。例如:www.aliyun.com:203.0.3.55|203.3.44.67,表示 www.aliyun.com 域名下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。

www.aliyun.com:203.0.3.55|203.3.44.67
PageTamperstring

监测页面出现了域名设置之外的元素都属于页面被篡改。常见的表现形式为弹出广告、浮动广告、跳转等。

填写格式:域名:元素。元素支持填写通配符,可以填写多个元素,多个元素以竖线(|)隔开。例如:www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg,表示 www.aliyun.com 域名下除基础文档、/cc/bb/a.gif 和/vv/bb/cc.jpg 之外的其他元素都属于页面被篡改。

www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg
FlowHijackJumpTimesinteger

识别元素:设置浏览页面元素总个数。

0
Streamobject

流媒体拨测配置。

TargetUrlstring

流媒体资源地址。

http://www.aliyun.com/stream/test.mp4
StreamTypeinteger

音视频标志:

  • 0:视频
  • 1:音频
0
StreamMonitorTimeoutinteger

监测时长,单位秒,最长支持 60s,不传默认 60。

30
StreamAddressTypeinteger

资源地址类型:

  • 1:资源地址。
  • 0:页面地址。不传默认 0。
0
PlayerTypeinteger

播放器,不传默认 12。

  • 12:VLC
  • 2:FlashPlayer
12
CustomHeaderContentobject

自定义 header,JSON Map 格式。

string

自定义 header,JSON Map 格式。

{ "key1": "value1", "key2": "value2" }
WhiteListstring

DNS 劫持白名单。匹配规则支持 IP、IP 通配符、子网掩码和 CNAME,可以填写多个匹配规则,多个匹配规则以竖线(|)隔开。例如:www.aliyun.com:203.0.3.55|203.3.44.67,表示 www.aliyun.com 域名下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。

www.aliyun.com:203.0.3.55|203.3.44.67
MonitorCategorylong

监测点类型:

  • 1:PC 端
  • 2:移动端
1
Monitorsarray<object>

监测点列表。

object

监测点列表。

CityCodestring

城市编码。

110100
OperatorCodestring

运营商编码。

1
ClientTypeinteger

拨测点客户端类型:

  • 1:IDC
  • 2:网民
  • 3:移动端
  • 4:云主机
1
Frequencystring

拨测频率,可选范围:1m、5m、10m、15m、20m、30m、1h、2h、3h、4h、6h、8h、12h、24h。

5m
CustomPeriodobject

自定义周期

EndHourlong

结束小时,0-24。

22
StartHourlong

开始小时,0-24。

14
CommonSettingobject

通用设置。

CustomHostobject

自定义 host。

Hostsarray<object>

host 列表。

object

自定义 host。

Domainstring

域名。

www.aliyun.com
IpTypeinteger

IP 类型:

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

IP 列表。

string

对应的 IP。

10.0.114.17
SelectTypeinteger

选择方式:

  • 0:随机
  • 1:轮询
0
IpTypeinteger

IP 类型:

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

是否均匀分配监测样本 :

  • 0:否
  • 1:是
0
IsOpenTraceboolean

是否开启链路追踪。

true
TraceClientTypeinteger

链路追踪客户端类型:

  • 0:ARMS Agent
  • 1:OpenTelemetry
  • 2:Jaeger
1
XtraceRegionstring

链路数据上报 region。

cn-hangzhou
CustomVPCSettingobject

用户 VPC 信息,如果拨测的是阿里云内网地址,需要配置 VPC 信息。

RegionIdstring

地域 ID。

cn-hangzhou
VpcIdstring

VPC ID.

vpc-2zexy5nae9q2otaxxxx
VSwitchIdstring

交换机 ID。

vsw-bp1i0xezblf1yrz4xxxxx
SecureGroupIdstring

安全组 ID,此安全组是拨测客户端所在的安全组,安全组限定了拨测客户端在 VPC 中的出入站规则。需要设置您的 VPC 所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则,拨测客户端无法顺畅地访问您的 VPC 内资源。

sg-xxxxxxx
CustomPrometheusSettingobject

保留字段。

PrometheusLabelsobject

保留字段。

string

保留字段。

保留字段。
PrometheusClusterIdstring

保留字段。

保留字段。
PrometheusClusterRegionstring

保留字段。

保留字段。
AvailableAssertionsarray<object>

断言列表。

object

断言列表。

Typestring

断言类型,包括:HttpResCode、HttpResHead、HttpResBody、HttpResBodyJson、HttpResponseTime、IcmpPackLoss(丢包率)、IcmpPackMaxLatency(最大包延时 ms)、IcmpPackAvgLatency(平均延时)、TraceRouteHops(跃点数目)、DnsARecord(A 记录)、DnsCName(Cname)、websiteTTFB(首包时间)、websiteTTLB(尾包时间)、websiteFST(首屏时间)、websiteFFST(首屏完全渲染时间)、websiteOnload(完全加载时间),具体使用见下文补充说明。

websiteTTLB
Targetstring

检查目标,当为 HttpResCode 与 HttpResBody、HttpResponseTime 时,target 不需要填,当为 HttpResHead 时,需指定 header 中的 key,当为 HttpResBodyJson 时,使用 jsonPath。

key
Operatorstring

条件:

  • gt:大于
  • gte:大于等于
  • lt:小于
  • te:小于或等于
  • eq:等于
  • neq:不等于
  • ctn:包含
  • nctn:不包含
  • exist:存在
  • n_exist:不存在
  • belong:属于
  • n_belong:不属于
  • reg_match:正则匹配
gt
Expectstring

期望值。

100
Statusstring
  • CREATING:任务创建中
  • RUNNING:任务运行中
  • PARTIAL_RUNNING:任务部分运行中
  • STOP:任务停止
  • LIMIT_STOP:任务由于限额停止
  • EXCEPTION:任务异常
  • DELETE:任务删除
  • DELETE_EXCEPTION: 删除异常
RUNNING
ResourceGroupIdstring

资源组 ID。

default
Tagsarray<object>

标签。

object

标签。

Keystring

Tag 的键。

user1
Valuestring

Tag 的值

p_运维

示例

正常返回示例

JSON格式

{
  "RequestId": "E13430A6-57A9-56E9-9D8D-28FE8DEBCA40",
  "Code": 200,
  "Message": "success",
  "Data": {
    "TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
    "RegionId": "cn-hangzhou",
    "Name": "拨测任务",
    "TaskType": 5,
    "MonitorConf": {
      "NetICMP": {
        "TargetUrl": "www.aliyun.com",
        "Interval": 200,
        "PackageNum": 4,
        "PackageSize": 1024,
        "SplitPackage": true,
        "Timeout": 2000,
        "TracertEnable": true,
        "TracertNumMax": 64,
        "TracertTimeout": 60000
      },
      "NetTCP": {
        "TargetUrl": "127.0.0.1:8888",
        "ConnectTimes": 4,
        "Interval": 200,
        "Timeout": 20000,
        "TracertEnable": true,
        "TracertNumMax": 20,
        "TracertTimeout": 60000
      },
      "NetDNS": {
        "TargetUrl": "www.aliyun.com",
        "DnsServerIpType": 0,
        "NsServer": "114.114.114.114",
        "QueryMethod": 0,
        "Timeout": 5000
      },
      "ApiHTTP": {
        "TargetUrl": "http://127.0.0.1:8090/api/list",
        "Method": "POST",
        "RequestHeaders": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "RequestBody": {
          "Content": "text/plain",
          "Type": "multipart/form-data"
        },
        "ConnectTimeout": 5000,
        "Timeout": 10000,
        "CheckCert": false,
        "ProtocolAlpnProtocol": 1
      },
      "FileDownload": {
        "TargetUrl": "https://********",
        "DownloadKernel": 0,
        "QuickProtocol": 1,
        "ConnectionTimeout": 5000,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "IgnoreCertificateStatusError": 0,
        "IgnoreCertificateUntrustworthyError": 0,
        "IgnoreInvalidHostError": 0,
        "MonitorTimeout": 6000,
        "Redirection": 0,
        "TransmissionSize": 2048,
        "IgnoreCertificateCanceledError": 0,
        "IgnoreCertificateAuthError": 0,
        "IgnoreCertificateOutOfDateError": 0,
        "IgnoreCertificateUsingError": 0,
        "VerifyWay": 0,
        "ValidateKeywords": "success",
        "WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
      },
      "Website": {
        "TargetUrl": "http://www.aliyun.com",
        "AutomaticScrolling": 0,
        "CustomHeader": 0,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}\n"
        },
        "DisableCache": 1,
        "DisableCompression": 0,
        "FilterInvalidIP": 0,
        "IgnoreCertificateError": 0,
        "MonitorTimeout": 20000,
        "Redirection": 1,
        "SlowElementThreshold": 5000,
        "WaitCompletionTime": 5000,
        "VerifyStringBlacklist": "error",
        "VerifyStringWhitelist": "success",
        "ElementBlacklist": "www.example.com/a.jpg",
        "DNSHijackWhitelist": "www.aliyun.com:203.0.3.55|203.3.44.67",
        "PageTamper": "www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg",
        "FlowHijackJumpTimes": 0,
        "FlowHijackLogo": "aliyun"
      },
      "Stream": {
        "TargetUrl": "http://www.aliyun.com/stream/test.mp4",
        "StreamType": 0,
        "StreamMonitorTimeout": 30,
        "StreamAddressType": 0,
        "PlayerType": 12,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
      }
    },
    "MonitorCategory": 1,
    "Monitors": [
      {
        "CityCode": "110100",
        "OperatorCode": "1",
        "ClientType": 1
      }
    ],
    "Frequency": "5m",
    "CustomPeriod": {
      "EndHour": 22,
      "StartHour": 14
    },
    "CommonSetting": {
      "CustomHost": {
        "Hosts": [
          {
            "Domain": "www.aliyun.com",
            "IpType": 0,
            "Ips": [
              "10.0.114.17"
            ]
          }
        ],
        "SelectType": 0
      },
      "IpType": 0,
      "MonitorSamples": 0,
      "IsOpenTrace": true,
      "TraceClientType": 1,
      "XtraceRegion": "cn-hangzhou",
      "CustomVPCSetting": {
        "RegionId": "cn-hangzhou",
        "VpcId": "vpc-2zexy5nae9q2otaxxxx",
        "VSwitchId": "vsw-bp1i0xezblf1yrz4xxxxx",
        "SecureGroupId": "sg-xxxxxxx"
      },
      "CustomPrometheusSetting": {
        "PrometheusLabels": {
          "key": "保留字段。"
        },
        "PrometheusClusterId": "保留字段。",
        "PrometheusClusterRegion": "保留字段。"
      }
    },
    "AvailableAssertions": [
      {
        "Type": "websiteTTLB",
        "Target": "key\n",
        "Operator": "gt",
        "Expect": "100"
      }
    ],
    "Status": "RUNNING",
    "ResourceGroupId": "default",
    "Tags": [
      {
        "Key": "user1",
        "Value": "p_运维"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400ParameterMissing%s
400ParameterIllegal%s
400TaskQuotaLimit%s
400ParameterRegionIllegal%s
400DuplicateTagKeyParam tagKey is duplicate.
400TagNumOUTthe number of tag is out .
400NoPermissionUSERuser no permission
403RAMNotAuthorize%s
403STSNotAuthorize%s
403IllegalUserAccess%s
403APINotAuthorize%s
403CommercialStatusException%s
403SyntheticTrailExpired%s
403SyntheticInDebt%s
403SyntheticDailyTimesExhausted%s
403SyntheticDailyLimit%s

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

变更历史

变更时间变更内容概要操作
2024-04-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-02-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-10-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情