分页查询拨测任务列表

最近更新时间:2024-04-03 11:11:58

我的收藏

1. 接口描述

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

查询拨测任务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProbeTasks。
Version String 公共参数,本接口取值:2018-04-09。
Region String 公共参数,此参数为可选参数。
TaskIDs.N Array of String 任务 ID 列表
示例值:["task-xx"]
TaskName String 任务名
示例值:probe
TargetAddress String 拨测目标
示例值:http://www.qq.com
TaskStatus.N Array of Integer 任务状态列表
  • 1 = 创建中
  • 2 = 运行中
  • 3 = 运行异常
  • 4 = 暂停中
  • 5 = 暂停异常
  • 6 = 任务暂停
  • 7 = 任务删除中
  • 8 = 任务删除异常
  • 9 = 任务删除
  • 10 = 定时任务暂停中

  • 示例值:[1,2]
    Offset Integer 偏移量,默认为0
    示例值:1
    Limit Integer 返回数量,默认为20,最大值为100
    示例值:10
    PayMode Integer 付费模式
  • 1 = 试用版本
  • 2 = 付费版本

  • 示例值:1
    OrderState Integer 订单状态
  • 1 = 正常
  • 2 = 欠费

  • 示例值:1
    TaskType.N Array of Integer 拨测类型
  • 1 = 页面浏览
  • 2 =文件上传
  • 3 = 文件下载
  • 4 = 端口性能
  • 5 = 网络质量
  • 6 =流媒体


  • 即使拨测只支持页面浏览,网络质量,文件下载
    示例值:[1,2,3]
    TaskCategory.N Array of Integer 节点类型
    示例值:[1,2,3]
    OrderBy String 排序的列
    示例值:task_category
    Ascend Boolean 是否正序
    示例值:true
    TagFilters.N Array of KeyValuePair 资源标签值
    示例值:[{"Key":"name", "Value": "zhangsan"}]

    3. 输出参数

    参数名称 类型 描述
    TaskSet Array of ProbeTask 任务列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    Total Integer 任务总数
    示例值:3
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例2

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeProbeTasks
    <公共请求参数>
    
    {
        "Limit": "10",
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "RequestId": "81a92494-0fb9-4b10-8ce4-bfa4565cf4eb",
            "TaskSet": null,
            "Total": 0
        }
    }

    示例2 示例3

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeProbeTasks
    <公共请求参数>
    
    {
        "Limit": "10",
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "RequestId": "11483de9-9be5-4537-a846-339a57f0e90e",
            "TaskSet": null,
            "Total": 0
        }
    }

    示例3 示例5

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeProbeTasks
    <公共请求参数>
    
    {}

    输出示例

    {
        "Response": {
            "RequestId": "d7628289-fd3c-4acf-a140-a33dd02b3ff6",
            "TaskSet": null,
            "Total": 0
        }
    }

    示例4 查询拨测任务列表

    输入示例

    POST / HTTP/1.1
    Host: cat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeProbeTasks
    <公共请求参数>
    
    {
        "TaskIDs": [
            "task-xx"
        ],
        "TagFilters": [
            {
                "Key": "name",
                "Value": "zhangsan"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TaskSet": [
                {
                    "Name": "abc",
                    "TaskId": "abc",
                    "TaskType": 0,
                    "Nodes": [
                        "abc"
                    ],
                    "NodeIpType": 0,
                    "Interval": 0,
                    "Parameters": "abc",
                    "Status": 0,
                    "TargetAddress": "abc",
                    "PayMode": 0,
                    "OrderState": 0,
                    "TaskCategory": 0,
                    "CreatedAt": "abc",
                    "Cron": "abc",
                    "CronState": 0,
                    "TagInfoList": [
                        {
                            "Key": "abc",
                            "Value": "abc"
                        }
                    ]
                }
            ],
            "Total": 0,
            "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.NoValidNodes 无有效节点。
    FailedOperation.ResourceNotFound 资源不存在。
    InternalError 内部错误。
    InvalidParameter 参数错误。