文档

UpdateTimingSyntheticTask - 更新定时拨测任务

更新时间:

更新定时拨测任务。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
TaskIdstring

云拨测任务 ID。

5308a2691f59422c8c3b7aeccxxxxxxx
Namestring

任务名称。

拨测任务
MonitorConfobject

任务配置。

NetICMPobject

ICMP 任务配置。

TargetUrlstring

拨测目标地址,只能输入 IP 地址或者域名,不能包括端口号、协议头、请求路径等。

www.aliyun.com
Intervallong

发送间隔,ICMP(PING)包发送的时间间隔必须在 200~10000ms 之间。

300
PackageNuminteger

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

4
PackageSizeinteger

发送 ICMP(Ping)数据包的大小。单位为 byte,ICMP(PING)包大小只限 32, 64, 128, 256, 512, 1024, 1080, 1450。

32
SplitPackageboolean

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

true
Timeoutlong

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

5000
TracertEnableboolean

是否开启 tracert。默认为 true。

true
TracertNumMaxinteger

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

20
TracertTimeoutlong

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

60000
NetTCPobject

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

TargetUrlstring

拨测目标地址(主机)。

127.0.0.1:8888
ConnectTimesinteger

建立 TCP 连接的次数。最小值为 1,最大值为 16,默认为 4。

4
Intervallong

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

300
Timeoutlong

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

1000
TracertEnableboolean

是否开启 tracert。默认为 true。

true
TracertNumMaxinteger

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

20
TracertTimeoutlong

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

1000
NetDNSobject

DNS 任务配置参数。

TargetUrlstring

域名。

www.aliyun.com
Diginteger

是否以 dig 形式展示数据内容, 0-否,1-是。

0
DnsServerIpTypeinteger

DNS 服务器 IP 类型。0:ipv4,1:ipv6,2: 自动,默认为 0。

0
NsServerstring

NS 服务器 IP,默认 114.114.114.114。

114.114.114.114
QueryMethodinteger

DNS 查询方式,0-递归,1-迭代,默认为 0。

0
Timeoutlong

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

1000
ApiHTTPobject

HTTP(s)类型任务配置。

TargetUrlstring

拨测目标地址(请求路径)。

https://********
Methodstring

请求方法。

  • POST
  • GET
POST
RequestHeadersobject

指定的自定义请求头部字段。

string

HTTP 请求头。

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

HTTP 请求体

Contentstring

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

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

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

application/json
ConnectTimeoutlong

连接超时,单位 ms,默认 5000,可选范围 1000~300000。

5000
Timeoutlong

超时时间,单位 ms,默认 10000,可选范围 1000~300000。

5000
CheckCertboolean

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

true
Websiteobject

网站测速类型任务配置。

TargetUrlstring

网址。

https://********
AutomaticScrollinginteger

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

0
CustomHeaderinteger

自定义 header。0:关(默认),1:修改第一包,2:修改全部包。

0
CustomHeaderContentobject

自定义 header,JSON Map 格式。

string

自定义 header,JSON Map 格式。

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

是否禁用缓存,0-不禁用,1-禁用,默认为 1。

0
DisableCompressioninteger

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

0
FilterInvalidIPinteger

是否过滤非有效 IP。

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

是否忽略在 SSL 握手中证书校验过程中的证书错误而继续浏览,0-不忽略,1-忽略,默认为 1。

0
MonitorTimeoutlong

监测超时,单位为 ms,默认 40000,可选范围为 5000~300000ms。

20000
Redirectioninteger

当出现重定向后,是否要继续浏览, 0-否,1-是,默认是 1。

0
SlowElementThresholdlong

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

5000
WaitCompletionTimelong

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

5000
VerifyStringBlackliststring

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

error
VerifyStringWhiteliststring

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

success
ElementBlackliststring

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

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
FlowHijackJumpTimesinteger

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

1
FileDownloadobject

文件下载类型任务配置。

TargetUrlstring

文件下载链接。

https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png
DownloadKernelinteger

下载内核。

  • 1:curl
  • 0:WinInet
0
QuickProtocolinteger

Quick 协议

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

连接超时时间,ms,默认 5000,可选范围:1000~120000ms 之间。

5000
MonitorTimeoutlong

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

60000
CustomHeaderContentobject

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

string

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

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

证书状态错误忽略,0:不忽略,1:忽略,默认 1。

0
IgnoreCertificateUntrustworthyErrorinteger

证书不可信忽略,0:不忽略,1:忽略,默认 1。

0
IgnoreInvalidHostErrorinteger

主机无效错误忽略,0:不忽略,1:忽略,默认 1。

0
Redirectioninteger

是否支持重定向, 0:不支持,1:支持,默认 1。

0
TransmissionSizelong

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

2048
IgnoreCertificateCanceledErrorinteger

忽略证书撤销错误 0:不忽略,1:忽略,默认 1。

0
IgnoreCertificateAuthErrorinteger

忽略 CA 证书授权错误 0:不忽略,1:忽略,默认 1。

0
IgnoreCertificateOutOfDateErrorinteger

忽略证书过期错误 0:不忽略,1:忽略,默认 1。

0
IgnoreCertificateUsingErrorinteger

忽略证书使用错误 0:不忽略,1:忽略,默认 1。

0
VerifyWayinteger

验证方式。

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

验证关键词。

aliyun
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
Streamobject

流媒体拨测配置。

TargetUrlstring

流媒体地址。

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

音视频标志:0-视频,1-音频。

0
StreamMonitorTimeoutinteger

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

30
StreamAddressTypeinteger

资源地址类型:

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

播放器,不传默认 12。

  • 12:VLC
  • 2:FlashPlayer
2
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
Monitorsobject []

监测点列表。

CityCodestring

城市编码。

100001
OperatorCodestring

运营商编码。

1
ClientTypeinteger

拨测点客户端类型:

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

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

5m
CustomPeriodobject

自定义周期。

EndHourinteger

当天结束拨测时间的小时数。

22
StartHourinteger

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

14
CommonSettingobject

通用设置。

CustomHostobject

自定义 host。

Hostsobject []

host 列表。

Domainstring

域名。

www.aliyun.com
IpTypeinteger

IP 类型:

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

IP 列表。

string

IP 地址。

127.0.0.1
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-bp15bjtubjytclwxxxxxx
VSwitchIdstring

交换机 ID。

vsw-2zevek6r3mpny7wxxxxxv
SecureGroupIdstring

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

sg-xxxxxxxx
AvailableAssertionsobject []

断言列表

Typestring

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

TraceRouteHops
Targetstring

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

HttpResponseTime
Operatorstring

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

eq
Expectstring

期望值。

200
ResourceGroupIdstring

资源组 ID。

rg-acfmxyexli2****
Tagsobject []

标签列表。

Keystring

标签的键(key)。

key
Valuestring

标签的值(value)。

value

断言配置说明如下:

HTTP 类型任务

  • type 为 HttpResCode 时,operator 支持 eq、neq、gt、gte、lt、lte、belong、n_belong
  • type 为 HttpResHead 时,operator 支持所有
  • type 为 HttpResBody,operator 支持所有
  • type 为 HttpResBodyJson,operator 支持所有
  • type 为 HttpResponseTime,支持 gt、gte、lt、lte、eq、belong

ICMP 类型任务

  • type 为 IcmpPackLoss 时,名称为丢包率%,支持 gt、gte、lt、lte、eq、belong
  • type 为 IcmpPackMaxLatency 时,名称为最大包延时 ms,支持 gt、gte、lt、lte、eq、belong
  • type 为 IcmpPackAvgLatency 时,名称为平均延时 ms,支持 gt、gte、lt、lte、eq、belong
  • TraceRouteHops 时,名称为跃点数目,支持 gt、gte、lt、lte、eq、belong

DNS 类型任务

  • type 为 DnsARecord 时,名称为 A 记录,target 有两个选择 every(展示-每条记录)和 any(展示-存在记录),支持 eq、ctn、nctn、reg_match、not_reg_match
  • type 为 DnsCName 时,名称为 Cname,target 有两个选择 every(展示-每条记录)和 any(展示-存在记录),支持 eq、ctn、nctn、reg_match、not_reg_match

WEBSITE 类型任务

  • type 为 websiteTTFB 时,名称为首包时间,支持 gt、gte、lt、lte、eq、belong
  • type 为 websiteTTLB 时,名称为尾包时间,支持 gt、gte、lt、lte、eq、belong
  • type 为 websiteFST 时,名称为首屏时间,支持 gt、gte、lt、lte、eq、belong
  • type 为 websiteFFST 时,名称为首屏完全渲染时间,支持 gt、gte、lt、lte、eq、belong
  • type 为 websiteOnload 时,名称为完全加载时间,支持 gt、gte、lt、lte、eq、belong

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

F7781D4A-2818-41E7-B7BB-79D809E9****
Successboolean

操作是否成功:

  • true:操作成功
  • false:操作失败
true
Codelong

状态码。200 为成功,其他状态码为异常。

200
Messagestring

返回信息。

success
Dataobject

返回结果。

TaskIdstring

任务 ID。

1eeb351722c84e05b52c82fd0dc9953e

示例

正常返回示例

JSON格式

{
  "RequestId": "F7781D4A-2818-41E7-B7BB-79D809E9****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "TaskId": "1eeb351722c84e05b52c82fd0dc9953e"
  }
}

错误码

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
403INNER_PROHIBIT内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙

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

变更历史

变更时间变更内容概要操作
2024-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2024-02-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2024-01-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    删除入参:TaskType
    删除入参:MonitorCategory
2023-11-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-10-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
  • 本页导读 (1)
文档反馈