创建拨测任务

最近更新时间：2020-01-08 19:03:55

我的收藏

本页目录：

1. 接口描述

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

创建拨测任务（创建任务并发起验证）

操作提示：下一步，请通过VerifyCatResult 接口，验证一下拨测验证是否成功。如果成功，则可通过RunTask 接口运行该任务。

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateTask。
Version	是	String	公共参数，本接口取值：2018-04-09。
Region	否	String	公共参数，本接口不需要传递此参数。
AgentGroupId	是	Integer	拨测分组id，体现本拨测任务要采用那些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见：DescribeAgentGroupList 接口，本参数使用返回结果里的groupId的值。
CatTypeName	是	String	http, https, ping, tcp 之一
Url	是	String	拨测的url 例如：www.baidu.com (url域名解析需要能解析出具体的ip)
TaskName	是	String	拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
Host	否	String	需要满足ip 的格式
Port	否	Integer	服务端监听或接收数据的端口
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信息
Period	否	Integer	拨测周期。取值可为1,5,15,30之一, 单位：分钟。精度不能低于用户等级规定的最小精度
TaskId	否	Integer	任务号。用于验证且修改任务时传入原任务号

3. 输出参数

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

4. 示例

示例1 创建拨测任务示例

输入示例

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

输出示例

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

5. 开发者资源

API Explorer

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

API 3.0 Explorer

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

下一篇: 产品动态