创建拨测任务(扩展)

最近更新时间:2020-03-18 08:00:37

1. 接口描述

接口请求域名: cat.tencentcloudapi.com 。

创建拨测任务(扩展)

默认接口请求频率限制:300次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTaskEx。
Version String 公共参数,本接口取值:2018-04-09。
Region String 公共参数,本接口不需要传递此参数。
CatTypeName String http, https, ping, tcp, ftp, smtp, udp, dns 之一
Url String 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
Period Integer 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
TaskName String 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
AgentGroupId Integer 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
Host String 指定域名(如需要)
IsHeader Integer 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
SslVer String URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
PostData String POST请求数据。空字符串表示非POST请求
UserAgent String 用户Agent信息
CheckStr String 要在结果中进行匹配的字符串
CheckType Integer 1 表示通过检查结果是否包含CheckStr 进行校验
Cookie String 需要设置的Cookie信息
TaskId Integer 任务ID,用于验证且修改任务时传入原任务ID
UserName String 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
PassWord String 登录服务器的密码
ReqDataType Integer 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
ReqData String 发起TCP, UDP请求的协议请求数据
RespDataType Integer 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
RespData String 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
DnsSvr String 目的DNS服务器 可以为空字符串
DnsCheckIp String 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
DnsQueryType String 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
UseSecConn Integer 是否使用安全链接SSL, 0 不使用,1 使用
NeedAuth Integer FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
Port Integer 拨测目标的端口号
Type Integer Type=0 默认 (站点监控)Type=2 可用率监控
IsVerify Integer IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
RedirectFollowNum Integer 跟随跳转次数,取值范围0-5,不传则表示不跟随

3. 输出参数

参数名称 类型 描述
ResultId Integer 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
TaskId Integer 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建拨测任务示例(扩展)

输入示例

https://cat.tencentcloudapi.com/?Action=CreateTaskEx
&CatTypeName=http
&Period=5
&AgentGroupId=1510
&Url=www.tencent.com
&TaskName=test_http
&<公共请求参数>

输出示例

{
  "Response": {
    "ResultId": 28330,
    "TaskId": 24454,
    "RequestID": "6de91190-a148-97a4-a935-f44cf51e1d61"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。