CreateSyntheticTask - 创建或更新云拨测任务

更新时间: 2024-02-01 22:12:56

创建或更新云拨测定时任务。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
TaskNamestring

任务名称。如果需要更新已创建的云拨测任务,此处填写已有的任务名称,并设置 UpdateTask 参数为 true

网络拨测任务
Urlstring

拨测地址。

https://www.example.com
MonitorListobject []

监测点列表。

CityCodelong

城市 ID。

1100101
NetServiceIdlong

运营商 ID。

18
MonitorTypelong

运营商类型:

  • IDC
  • LastMilie
IDC
TaskTypelong

任务类型:

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

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

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

监测周期类型:

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

自定义扩展频率。

StartTimestring

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

2022-07-20 10
EndTimestring

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

2022-08-20 10
Daysarray

拨测执行周期。

long

拨测执行周期。

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

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

00
StartMinutelong

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

00
EndHourlong

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

23
EndMinutelong

当天结束拨测时间的分钟数。

00
IpTypelong

IP 类型:

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

网络任务。

NetICMPSwitchlong

Ping 监测开关。

  • 0:关。
  • 1:开,开启后需设置 ICMP 参数。
1
NetICMPActivelong

协议类型:

  • 0:ICMP
  • 1:TCP
0
NetICMPIntervallong

执行时间间隔。单位为秒。

1
NetICMPNumlong

Package 数量。

4
NetICMPSizelong

Package 大小。

32
NetDNSSwitchlong

DNS 监测开关。

  • 0:关。
  • 1:开,开启后需设置 DNS 参数。
1
NetDNSTimeoutlong

DNS 监测超时时间。默认值为 5 秒,取值范围为 0~45 秒。

5
NetDNSQueryMethodlong

DNS 查询方式:

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

指定 NS 服务器。

114.114.XX.XX
NetDigSwitchlong

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

  • 0:否
  • 1:是
0
NetDNSServerlong

DNS 服务器类型:

  • 0:IPv4
  • 1:IPv6
  • 2:自动
0
NetTraceRouteSwitchlong

Tracert 监测开关。

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

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

60
NetTraceRouteNumlong

最大活跃点数。

20
WhiteListstring

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

说明 WAP 网络不支持劫持。
www.aliyun.com:202.0.3.55|203.3.44.67
NetICMPTimeoutlong

监测超时取值范围。

20
NetICMPDataCutlong

切分 Package 开关。

  • 0:关
  • 1:开
0
CommonParamobject

公共参数。

AlarmFlagstring

是否创建报警:

  • 1:创建报警
  • 0:不创建报警
1
AlertListobject []

告警参数。

Namestring

告警规则名称。

网络拨测:

  • 时延:PING_SET
  • 丢包率:PING_LOST_RATE
  • 劫持:HIJACKPER
PING_SET
IsCriticallong

是否是必要条件。

true
Symbolslong

条件判断:

  • 1:大于
  • 0:小于
1
AlertPolicyIdstring

通知策略 ID。

1234
AlertNotifierIdstring

告警联系人 ID,多个联系人之间通过半角逗号(,)分隔。

123
StartExecutionTimelong

起始执行时间。

2022-07-20 10
MonitorSampleslong

是否均匀分配监测样本 :

  • 0:否
  • 1:是
0
Navigationobject

浏览任务监测关联项。

NavDisableCachelong

是否禁用缓存。

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

是否返回页面的元素。

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

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

  • 1:是
  • 0:否
1
NavDisableCompressionstring

通过 Accept-Encoding 字段判断是否接受压缩文件。

  • 1:禁用
  • 0:不禁用
1
NavAutomaticScrollingstring

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

  • 1:是
  • 0:否
1
NavIgnoreCertificateErrorlong

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

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

是否过滤非有效 IP。

  • 1:不过滤
  • 0:过滤
1
ExecuteApplicationlong

是否执行 Applet。

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

是否执行 ActiveX。

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

是否执行脚本。

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

设置 QUIC 版本。

  • 0(默认)
  • 35
  • 39
  • 43
  • 44
说明 仅 Chrome 全元素支持此参数。
0
QUICDomainstring

输入 QUIC 请求元素域名。

说明 仅 Chrome 全元素支持此参数。
www.example.com
RequestHeaderlong

是否返回请求头。

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

选择自定义 Host 模式。

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

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

ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com
NavCustomHeaderstring

自定义 header。

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

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

Host:www.example.com|Referer:www.example.com
ElementBlackliststring

元素黑名单。

*.a.com
ProcessNamestring

进程标识。

ssh
VerifyStringBlackliststring

验证字符串黑名单。截取页面代码中所包含的一段字符串,若检测样本中不包含则报错,支持正则表达配置格式【Regex:验证内容】,字符串黑名单多以"|"隔开。

Regex:*.example|expalme|
VerifyStringWhiteListstring

验证字符串白名单。截取页面代码中所包含的一段字符串,若检测样本中不包含则报错,支持正则表达配置格式【Regex:验证内容】,字符串白名单多以"|"隔开。

Regex:*.example|expalme|
MonitorTimeoutstring

监测超时,单位为秒。

20
WaitCompletionTimedouble

等待完成时间,单位为秒。

15
SlowElementThresholddouble

慢元素阈值,单位为秒。

5
DNSHijackWhiteListstring

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

www.aliyun.com:202.0.3.55|203.3.44.67
PageTamperstring

页面篡改。填写规则:冒号前部分为要判断的域名,冒号后部分为匹配规则;匹配规则支持确切 IP\ip 通配符\子网掩码\cname,多个以竖线分割。

www.example.com:202.0.3.55|203.3.44.67
FlowHijackJumpTimeslong

识别元素。

50
ResponseHeaderlong

返回响应头。

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

文件下载任务。

DownloadTransmissionSizelong

传输大小,单位为 KB。

10240
DownloadCustomHostlong

自定义 Host。

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

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

ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com
WhiteListstring

DNS 劫持白名单。

[{\"src\":\"211.154.166.174\"}]
DownloadKernellong

下载内核。

  • 1:curl
  • 0:WinInet
1
QuickProtocolstring

Quick 协议

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

监测时长。

30
ConnectionTimeoutdouble

连接超时。

200
VerifyWaylong

验证方式。

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

验证关键词。截取响应头中所包含的一段字符串,若监测样本中不包含则报错。

keyword
DownloadRedirectionlong

是否支持重定向。

0
DownloadCustomHeaderContentstring

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

Host:www.example.com|Referer:www.example.com
DownloadIgnoreCertificateErrorstring

证书错误忽略内容。将复选框的值用竖线(|)拼接传递。复选框的值支持 1:忽略证书状态错误;2:忽略证书不可信错误;4:忽略无效主机名错误。

1|2|4
Protocolobject

API 性能任务。

RequestContentobject

请求内容,包含 Header 和 Body。

Methodstring

请求方法。

  • POST
  • GET
POST
Headerobject []

自定义发起 API 性能拨测时的请求 Header。

Keystring

Header 的 Key。

regionId
Valuestring

Header 的 Value。

cn-hangzhou
Bodyobject

自定义发起 API 性能拨测时的请求 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
UrlEncodingobject []

Mode 设置为x-www-form-urlencoded时传入的数据内容。

Keystring

x-www-form-urlencoded的 Key。

appId
Valuestring

x-www-form-urlencoded的 Value。

11080
Rawstring

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

content
Languagestring

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

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

字符编码。

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

验证响应内容。

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

验证内容。

"code":200
ReceivedDataSizelong

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

500
ProtocolMonitorTimeoutstring

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

30
CustomHostlong

自定义 Host。

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

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

ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com
ProtocolConnectionTimelong

协议连接超时时间,单位为秒。

3
UpdateTaskboolean

是否更新已有云拨测任务。

  • true:更新任务。
  • false:新建任务。
false

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A5EC8221-08F2-4C95-9AF1-49FD998C****
Codestring

系统返回状态码:

  • 1001:请求成功
  • 1002:请求失败
  • 1003:参数错误
  • 1004:鉴权失败
  • 1006:任务不存在
  • 1099:内部错误
1001
Msgstring

任务创建失败的返回说明。

null
Dataobject

云拨测任务信息。

TaskIdlong

云拨测任务 ID。

1234

示例

正常返回示例

JSON格式

{
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****",
  "Code": "1001",
  "Msg": "null",
  "Data": {
    "TaskId": 1234
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-25OpenAPI 描述信息更新、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
入参OpenAPI 入参发生变更
    新增入参:UpdateTask
2022-08-12API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Navigation
    新增入参:Download
    新增入参:Protocol
2022-07-22新增 OpenAPI看变更集
阿里云首页 应用实时监控服务 相关技术圈