1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
修改拨测任务。未出现在请求中的字段保持原值。启动范围传空字符串表示清空该项。Type 和 ExecutionTime 创建后不可修改。暂停和恢复通过 Status 完成,不提供单独的状态接口。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyTDEMDialTask。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID 示例值:5 |
| TaskId | 是 | String | 任务 ID 示例值:1 |
| TaskName | 否 | String | 任务名称。不传表示不修改。 示例值:capi-selftest-0930-mod |
| Status | 否 | String | 任务状态。取值说明:active、paused。不传表示不修改。不能改为 deleted。 示例值:active |
| Type | 否 | String | 探测类型。创建后不可修改。 示例值:icmp |
| ExecutionTime | 否 | String | 执行时机。创建后不可修改。 示例值:realtime |
| WatchDomain | 否 | String | 监听域名。不传表示不修改。 示例值:postman-echo.com |
| DialDomain | 否 | String | 拨测目标。不传表示不修改。 示例值:www.qq.com |
| Port | 否 | Integer | TCP 端口。不传表示不修改。 示例值:443 |
| FrequencyMs | 否 | Integer | 实时拨测间隔,单位毫秒。不传表示不修改。 示例值:60000 |
| TimeoutMs | 否 | Integer | 单次探测超时,单位毫秒。不传表示不修改。 示例值:3000 |
| PeriodMs | 否 | Integer | 探测周期,单位毫秒。不传表示不修改。 示例值:60000 |
| PackageCount | 否 | Integer | 发包次数。不传表示不修改。 示例值:3 |
| PackageSize | 否 | Integer | ICMP 包大小,单位字节。不传表示不修改。 示例值:64 |
| NeedMTR | 否 | Integer | 是否做路由追踪。取值说明:0 否,1 是。不传表示不修改。 示例值:0 |
| MTRTimeoutMs | 否 | Integer | 路由追踪超时,单位毫秒。不传表示不修改。 示例值:10000 |
| MTRMaxHop | 否 | Integer | 路由追踪最大跳数。不传表示不修改。 示例值:30 |
| MTRPingCount | 否 | Integer | 每一跳发包次数。不传表示不修改。 示例值:5 |
| SlowThresholdMs | 否 | Integer | 慢请求阈值,单位毫秒。不传表示不修改。 示例值:2000 |
| ErrorType | 否 | String | 错误类型过滤。不传表示不修改。 示例值:5xx |
| Regions | 否 | String | 允许启动的客户端地区,逗号分隔,名称必须与分析页客户端地区完全一致。不传保留原值,空字符串清空。空名单表示不限制。 示例值:广东省 |
| Operators | 否 | String | 允许启动的客户端运营商,逗号分隔,名称必须与分析页客户端运营商完全一致。不传保留原值,空字符串清空。空名单表示不限制。 示例值:中国电信 |
| UserIds | 否 | String | 允许启动的用户 ID,逗号分隔。不传保留原值,空字符串清空。空名单表示不限制。 示例值:demo_user_001 |
| DeviceIds | 否 | String | 允许启动的设备 ID,逗号分隔。不传保留原值,空字符串清空。空名单表示不限制。 示例值:d86001 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改拨测任务
修改任务定义。暂停或恢复时把 Status 设为 paused 或 active。
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTDEMDialTask
<公共请求参数>
{
"AppId": "5",
"TaskId": "1",
"TaskName": "capi-selftest-0930-mod",
"Status": "active",
"Type": "icmp",
"ExecutionTime": "realtime",
"WatchDomain": "postman-echo.com",
"DialDomain": "www.qq.com",
"Port": 443,
"FrequencyMs": 60000,
"TimeoutMs": 3000,
"PeriodMs": 60000,
"PackageCount": 3,
"PackageSize": 64,
"NeedMTR": 0,
"MTRTimeoutMs": 10000,
"MTRMaxHop": 30,
"MTRPingCount": 5,
"SlowThresholdMs": 2000,
"ErrorType": "5xx",
"Regions": "广东省",
"Operators": "中国电信",
"UserIds": "demo_user_001",
"DeviceIds": "d86001"
}
输出示例
{
"Response": {
"RequestId": "7b8fd8c6-5bf3-4a8d-9165-0bbd7980af9b"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |