批量创建拨测任务

最近更新时间:2024-07-26 01:15:08

我的收藏

1. 接口描述

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

批量创建拨测任务

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateProbeTasks。
Version String 公共参数,本接口取值:2018-04-09。
Region String 公共参数,此参数为可选参数。
BatchTasks.N Array of ProbeTaskBasicConfiguration 批量任务名-地址
TaskType Integer 任务类型,如1、2、3、4、5、6、7;1-页面性能、2-文件上传、3-文件下载、4-端口性能、5-网络质量、6-音视频体验、7-域名whois
示例值:1
Nodes.N Array of String 拨测节点,如10001,具体拨测地域运营商对应的拨测点编号可联系云拨测确认。
示例值:["10001"]
Interval Integer 拨测间隔
示例值:30
Parameters String 拨测参数,详细可参考云拨测官方文档,链接:https://cloud.tencent.com/document/product/248/87308#createprobetasks。
示例值:{}
TaskCategory Integer 任务分类
  • 1 = PC
  • 2 = Mobile

  • 示例值:1
    Cron String 定时任务cron表达式
    示例值:* 0-5 * * *
    Tag.N Array of Tag 资源标签值
    示例值:[{"TagKey":"a", "TagValue": "a1"}]
    ProbeType Integer 测试类型,包含定时测试与即时测试。0-定时拨测,其它表示即时拨测。
    示例值:1
    PluginSource String 插件类型,如CDN,详情参考云拨测官方文档。
    示例值:CDN
    ClientNum String 客户端ID
    示例值:3198058
    NodeIpType Integer 拨测点IP类型:0-不限制IP类型,1-IPv4,2-IPv6
    示例值:0
    SubSyncFlag Integer 供应商子账户同步标志

    3. 输出参数

    参数名称 类型 描述
    TaskIDs Array of String 任务ID列表
    示例值:["task-fsz5tuvy"]
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例1

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateProbeTasks
    <公共请求参数>
    
    {
        "BatchTasks": [
            {
                "TargetAddress": "http://www.baidu.com",
                "Name": "CDN验证21"
            }
        ],
        "Parameters": "{\"ipType\":0,\"grabBag\":0,\"netIcmpOn\":1,\"netIcmpActivex\":0,\"netIcmpTimeout\":20,\"netIcmpInterval\":0.5,\"netIcmpNum\":20,\"netIcmpSize\":32,\"netIcmpDataCut\":1,\"netDnsOn\":1,\"netDnsTimeout\":5,\"netDnsQuerymethod\":1,\"netDnsNs\":\"\",\"netDigOn\":1,\"netDnsServer\":2,\"netTracertOn\":1,\"netTracertTimeout\":60,\"netTracertNum\":30,\"whiteList\":\"\",\"blackList\":\"\",\"netIcmpActivexStr\":\"\"}",
        "TaskCategory": "1",
        "Interval": "5",
        "TaskType": "5",
        "Nodes": [
            "12136"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "0c4977a0-5b9f-469b-84d4-5d6a609e93a3",
            "TaskIDs": [
                "task-h4bcnook"
            ]
        }
    }

    示例2 批量创建拨测任务

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateProbeTasks
    <公共请求参数>
    
    {
        "BatchTasks": [
            {
                "Name": "probe",
                "TargetAddress": "http://www.baidu.com"
            }
        ],
        "Parameters": "{\"ipType\":0,\"grabBag\":0,\"netIcmpOn\":1,\"netIcmpActivex\":0,\"netIcmpTimeout\":20,\"netIcmpInterval\":0.5,\"netIcmpNum\":20,\"netIcmpSize\":32,\"netIcmpDataCut\":1,\"netDnsOn\":1,\"netDnsTimeout\":5,\"netDnsQuerymethod\":1,\"netDnsNs\":\"\",\"netDigOn\":1,\"netDnsServer\":2,\"netTracertOn\":1,\"netTracertTimeout\":60,\"netTracertNum\":30,\"whiteList\":\"\",\"blackList\":\"\",\"netIcmpActivexStr\":\"\"}",
        "Interval": 30,
        "TaskCategory": 1,
        "TaskType": 5,
        "Nodes": [
            "10001"
        ],
        "Cron": "* 0-6 * * *",
        "Tag": [
            {
                "TagKey": "abc",
                "TagValue": "a1"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TaskIDs": [
                "abc"
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.DbQueryFailed 数据库查询错误。
    FailedOperation.DbRecordCreateFailed 数据库创建失败。
    FailedOperation.DbRecordUpdateFailed 数据库更新失败。
    FailedOperation.ErrPrePaidResourceExpire 任务绑定的预付费套餐已过期。
    FailedOperation.NoValidNodes 无有效节点。
    FailedOperation.OrderOutOfCredit 账单欠费。
    FailedOperation.PreResourceIDFailed 预付费资源id绑定错误。
    FailedOperation.ResourceNotFound 资源不存在。
    FailedOperation.SendRequest 发送授权请求失败。
    FailedOperation.TagRequiredVerifyFailed 标签验证错误。
    FailedOperation.TaskNotRunning 任务未运行。
    FailedOperation.TaskNotSuspended 任务未暂停。
    FailedOperation.TaskOperationNotAllow 任务状态不允许当前操作。
    FailedOperation.TaskTypeNotSame 批量拨测任务的类型不相同。
    FailedOperation.TrialTaskExceed 试用任务量超时。
    FailedOperation.UnmarshalResponse json解析失败。
    FailedOperation.UserNoQcloudTAGFullAccess 鉴权失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。