修改拨测任务

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

1. 接口描述

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

修改 拨测任务。 如果验证未成功,请先验证成功。避免修改为失败率100%的拨测任务。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyTask。
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)
Period Integer 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
TaskName String 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
TaskId Integer 验证成功的拨测任务id
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信息

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改拨测任务示例

输入示例

https://cat.tencentcloudapi.com/?Action=ModifyTask
&AgentGroupId=100004185
&CatTypeName=http
&Url=http://www.baidu.com
&Period=5
&TaskName=HelpToTestBaidu
&TaskId=210837
&IsHeader=0
&<公共请求参数>

输出示例

{
  "Response": {
    "TaskId": 210837,
    "RequestId": "376cc3cc-f33c-47c4-800d-4f3fe06d9bab"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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