创建或更新云拨测定时任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:GetSyntheticTask | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。 | cn-hangzhou |
TaskName | string | 是 | 任务名称。如果需要更新已创建的云拨测任务,此处填写已有的任务名称,并设置UpdateTask参数为true。 | 网络拨测任务 |
Url | string | 是 | 拨测地址。 | https://www.example.com |
MonitorList | object [] | 是 | 监测点列表。 | |
CityCode | long | 是 | 城市ID。 | 1100101 |
NetServiceId | long | 是 | 运营商ID。 | 18 |
MonitorType | long | 是 | 运营商类型:
| IDC |
TaskType | long | 是 | 任务类型:
| 0 |
IntervalTime | string | 是 | 拨测频率,单位为分钟。可选频率如下:
| 5 |
IntervalType | string | 是 | 监测周期类型:
| 0 |
ExtendInterval | object | 否 | 自定义扩展频率。 | |
StartTime | string | 否 | 周期开始时间。格式为 | 2022-07-20 10 |
EndTime | string | 否 | 周期结束时间 。格式为 | 2022-08-20 10 |
Days | array | 否 | 拨测执行周期。 | |
long | 否 | 拨测执行周期。
| -1 | |
StartHour | long | 否 | 当天开始拨测时间的小时数。 | 00 |
StartMinute | long | 否 | 当天开始拨测时间的分钟数。 | 00 |
EndHour | long | 否 | 当天结束拨测时间的小时数。 | 23 |
EndMinute | long | 否 | 当天结束拨测时间的分钟数。 | 00 |
IpType | long | 是 | IP类型:
| 0 |
Net | object | 否 | 网络任务。 | |
NetICMPSwitch | long | 否 | Ping监测开关。
| 1 |
NetICMPActive | long | 否 | 协议类型:
| 0 |
NetICMPInterval | long | 否 | 执行时间间隔。单位为秒。 | 1 |
NetICMPNum | long | 否 | Package数量。 | 4 |
NetICMPSize | long | 否 | Package大小。 | 32 |
NetDNSSwitch | long | 否 | DNS监测开关。
| 1 |
NetDNSTimeout | long | 否 | DNS监测超时时间。默认值为5秒,取值范围为0~45秒。 | 5 |
NetDNSQueryMethod | long | 否 | DNS查询方式:
| 1 |
NetDNSNs | string | 否 | 指定NS服务器。 | 114.114.XX.XX |
NetDigSwitch | long | 否 | 是否以dig数据格式展示数据内容。
| 0 |
NetDNSServer | long | 否 | DNS服务器类型:
| 0 |
NetTraceRouteSwitch | long | 否 | Tracert监测开关。
| 1 |
NetTraceRouteTimeout | long | 否 | 监测超时,取值范围为0~300秒。 | 60 |
NetTraceRouteNum | long | 否 | 最大活跃点数。 | 20 |
WhiteList | string | 否 | DNS劫持白名单。填写格式: 说明
WAP网络不支持劫持。
| www.aliyun.com:202.0.3.55|203.3.44.67 |
NetICMPTimeout | long | 否 | 监测超时取值范围。 | 20 |
NetICMPDataCut | long | 否 | 切分Package开关。
| 0 |
CommonParam | object | 否 | 公共参数。 | |
AlarmFlag | string | 否 | 是否创建报警:
| 1 |
AlertList | object [] | 否 | 告警参数。 | |
Name | string | 否 | 告警规则名称。 网络拨测:
| PING_SET |
IsCritical | long | 否 | 是否是必要条件。 | true |
Symbols | long | 否 | 条件判断:
| 1 |
AlertPolicyId | string | 否 | 通知策略ID。 | 1234 |
AlertNotifierId | string | 否 | 告警联系人ID,多个联系人之间通过半角逗号(,)分隔。 | 123 |
StartExecutionTime | long | 否 | 起始执行时间。 | 2022-07-20 10 |
MonitorSamples | long | 否 | 是否均匀分配监测样本 :
| 0 |
Navigation | object | 否 | 浏览任务监测关联项。 | |
NavDisableCache | long | 否 | 是否禁用缓存。
| |
NavReturnElement | long | 否 | 是否返回页面的元素。
| |
NavRedirection | long | 否 | 当出现重定向后,是否要继续浏览。
| |
NavDisableCompression | string | 否 | 通过Accept-Encoding字段判断是否接受压缩文件。
| |
NavAutomaticScrolling | string | 否 | 是否支持自动滚动屏幕,加载页面。
| |
NavIgnoreCertificateError | long | 否 | 是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览。
| |
FilterInvalidIP | long | 否 | 是否过滤非有效IP。
| 1 |
ExecuteApplication | long | 否 | 是否执行Applet。
说明
仅IE全元素支持此参数。
| 1 |
ExecuteActiveX | long | 否 | 是否执行ActiveX。
说明
仅IE全元素支持此参数。
| 3 |
ExecuteScript | long | 否 | 是否执行脚本。
说明
仅IE全元素支持此参数。
| 1 |
QUICVersion | long | 否 | 设置QUIC版本。
说明
仅Chrome全元素支持此参数。
| 0 |
QUICDomain | string | 否 | 输入QUIC请求元素域名。 说明
仅Chrome全元素支持此参数。
| www.example.com |
RequestHeader | long | 否 | 是否返回请求头。
| 0 |
NavCustomHost | long | 否 | 选择自定义Host模式。
| |
NavCustomHostIp | string | 否 | 自定义Host IP。可以填写多个IP,每个IP用半角逗号(,)分隔。 | |
NavCustomHeader | string | 否 | 自定义header。
| |
NavCustomHeaderContent | string | 否 | 自定义Header格式。可以填写多个字段,多个字段以竖线(|)隔开。 | |
ElementBlacklist | string | 否 | 元素黑名单。 | *.a.com |
ProcessName | string | 否 | 进程标识。 | ssh |
VerifyStringBlacklist | string | 否 | 验证字符串黑名单。截取页面代码中所包含的一段字符串,若检测样本中不包含则报错,支持正则表达配置格式【Regex:验证内容】,字符串黑名单多以"|"隔开。 | Regex:*.example|expalme| |
VerifyStringWhiteList | string | 否 | 验证字符串白名单。截取页面代码中所包含的一段字符串,若检测样本中不包含则报错,支持正则表达配置格式【Regex:验证内容】,字符串白名单多以"|"隔开。 | Regex:*.example|expalme| |
MonitorTimeout | string | 否 | 监测超时,单位为秒。 | 20 |
WaitCompletionTime | double | 否 | 等待完成时间,单位为秒。 | 15 |
SlowElementThreshold | double | 否 | 慢元素阈值,单位为秒。 | 5 |
DNSHijackWhiteList | string | 否 | DNS劫持白名单。填写格式:域名:匹配规则。 | www.aliyun.com:202.0.3.55|203.3.44.67 |
PageTamper | string | 否 | 页面篡改。填写规则:冒号前部分为要判断的域名,冒号后部分为匹配规则;匹配规则支持确切IP\ip通配符\子网掩码\cname,多个以竖线分割。 | www.example.com:202.0.3.55|203.3.44.67 |
FlowHijackJumpTimes | long | 否 | 识别元素。 | 50 |
FlowHijackLogo | string | 否 | 劫持标识。劫持判断关键字或关键元素,可以带星号(*)。 | test |
ResponseHeader | long | 否 | 返回响应头。
| 0 |
Download | object | 否 | 文件下载任务。 | |
DownloadTransmissionSize | long | 否 | 传输大小,单位为KB。 | 10240 |
DownloadCustomHost | long | 否 | 自定义Host。
| 1 |
DownloadCustomHostIp | string | 否 | 自定义Host IP。可以填写多个IP,每个IP用半角逗号(,)分隔。 | ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com |
WhiteList | string | 否 | DNS劫持白名单。 | [{\"src\":\"211.154.166.174\"}] |
DownloadKernel | long | 否 | 下载内核。
| 1 |
QuickProtocol | string | 否 | Quick协议
| 1 |
MonitorTimeout | long | 否 | 监测时长。 | 30 |
ConnectionTimeout | double | 否 | 连接超时。 | 200 |
VerifyWay | long | 否 | 验证方式。
| 0 |
ValidateKeywords | string | 否 | 验证关键词。截取响应头中所包含的一段字符串,若监测样本中不包含则报错。 | keyword |
DownloadRedirection | long | 否 | 是否支持重定向。 | 0 |
DownloadCustomHeaderContent | string | 否 | 自定义Header格式。可以填写多个字段,多个字段以竖线(|)隔开。 | Host:www.example.com|Referer:www.example.com |
DownloadIgnoreCertificateError | string | 否 | 证书错误忽略内容。将复选框的值用竖线(|)拼接传递。复选框的值支持1:忽略证书状态错误;2:忽略证书不可信错误;4:忽略无效主机名错误。 | 1|2|4 |
Protocol | object | 否 | API性能任务。 | |
RequestContent | object | 否 | 请求内容,包含Header和Body。 | |
Method | string | 否 | 请求方法。
| POST |
Header | object [] | 否 | 自定义发起API性能拨测时的请求Header。 | |
Key | string | 否 | Header的Key。 | regionId |
Value | string | 否 | Header的Value。 | cn-hangzhou |
Body | object | 否 | 自定义发起API性能拨测时的请求Body。 | |
Mode | string | 否 | 内容类型。
| form-data |
FormData | object [] | 否 | Mode设置为form-data时传入的数据内容。 | |
Key | string | 否 | form-data的Key。 | appId |
Value | string | 否 | form-data的Value。 | 3425 |
UrlEncoding | object [] | 否 | Mode设置为x-www-form-urlencoded时传入的数据内容。 | |
Key | string | 否 | x-www-form-urlencoded的Key。 | appId |
Value | string | 否 | x-www-form-urlencoded的Value。 | 11080 |
Raw | string | 否 | Mode设置为raw时传入的数据内容。 | content |
Language | string | 否 | Mode设置为raw时选择的语言。
| json |
CharacterEncoding | long | 否 | 字符编码。
| 0 |
VerifyWay | long | 否 | 验证响应内容。
| 0 |
VerifyContent | string | 否 | 验证内容。 | "code":200 |
ReceivedDataSize | long | 否 | 接收数据大小。验证响应内容选择部分包含时填写。 | 500 |
ProtocolMonitorTimeout | string | 否 | 监测超时时间,单位为秒。 | 30 |
CustomHost | long | 否 | 自定义Host。
| 1 |
CustomHostIp | string | 否 | 自定义Host IP。可以填写多个IP,每个IP用半角逗号(,)分隔。 | ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com |
ProtocolConnectionTime | long | 否 | 协议连接超时时间,单位为秒。 | 3 |
UpdateTask | boolean | 否 | 是否更新已有云拨测任务。
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****",
"Code": "1001",
"Msg": "null",
"Data": {
"TaskId": 1234
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-08-25 | OpenAPI 描述信息更新,OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-08-12 | API 内部配置变更,不影响调用 | 看变更集 | ||||||||
| ||||||||||
2022-08-11 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-07-22 | 新增 OpenAPI | 看变更集 |