{
  "name": "cat",
  "display_name": "云拨测",
  "description": "介绍如何使用API对云拨测进行操作，包括拨测任务、拨测告警等。",
  "domain": "other",
  "api_version": "2018-04-09",
  "endpoint": "cat.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateProbeTasks",
      "description": "批量创建拨测任务",
      "status": "online",
      "parameters": [
        {
          "name": "BatchTasks",
          "type": "array",
          "required": true,
          "description": "批量任务名-地址",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "拨测任务名称",
              "example": "probe-task1"
            },
            {
              "name": "TargetAddress",
              "type": "string",
              "required": true,
              "description": "拨测目标地址",
              "example": "www.baidu.com"
            }
          ]
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": true,
          "description": "任务类型，如1、2、3、4、5、6、7；1-页面性能、2-文件上传、3-文件下载、4-端口性能、5-网络质量、6-音视频体验、7-域名whois",
          "example": "1"
        },
        {
          "name": "Nodes",
          "type": "array",
          "required": true,
          "description": "拨测节点，如10001，具体拨测地域运营商对应的拨测点编号可联系云拨测确认。",
          "example": "[\"10001\"]",
          "item_type": "string"
        },
        {
          "name": "Interval",
          "type": "integer",
          "required": true,
          "description": "拨测间隔，单位为分钟",
          "example": "30"
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": true,
          "description": "拨测参数，详细可参考云拨测官方文档,链接:https://cloud.tencent.com/document/product/248/87308#createprobetasks。",
          "example": "{\\\"ipType\\\":0,\\\"grabBag\\\":0,\\\"netIcmpOn\\\":1,\\\"netIcmpActivex\\\":0,\\\"netIcmpTimeout\\\":20,\\\"netIcmpInterval\\\":0.5,\\\"netIcmpNum\\\":20,\\\"netIcmpSize\\\":32,\\\"netIcmpDataCut\\\":1}"
        },
        {
          "name": "TaskCategory",
          "type": "integer",
          "required": true,
          "description": "任务分类 1 = PC 2 = Mobile",
          "example": "1"
        },
        {
          "name": "Cron",
          "type": "string",
          "required": false,
          "description": "定时任务cron表达式",
          "example": "* 0-5 * * *"
        },
        {
          "name": "Tag",
          "type": "array",
          "required": false,
          "description": "资源标签值",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "key",
              "example": "k"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "value",
              "example": "v"
            }
          ]
        },
        {
          "name": "ProbeType",
          "type": "integer",
          "required": false,
          "description": "测试类型，包含定时测试与即时测试。0-定时拨测，其它表示即时拨测。",
          "example": "1"
        },
        {
          "name": "PluginSource",
          "type": "string",
          "required": false,
          "description": "插件类型，如CDN，详情参考云拨测官方文档。",
          "example": "CDN"
        },
        {
          "name": "ClientNum",
          "type": "string",
          "required": false,
          "description": "客户端ID",
          "example": "3198058"
        },
        {
          "name": "NodeIpType",
          "type": "integer",
          "required": false,
          "description": "拨测点IP类型：0-不限制IP类型，1-IPv4，2-IPv6",
          "example": "0"
        },
        {
          "name": "SubSyncFlag",
          "type": "integer",
          "required": false,
          "description": "供应商子账户同步标志",
          "example": "0"
        },
        {
          "name": "RtxName",
          "type": "string",
          "required": false,
          "description": "创建者名称",
          "example": "weizhang"
        }
      ],
      "required": [
        "BatchTasks",
        "TaskType",
        "Nodes",
        "Interval",
        "Parameters",
        "TaskCategory"
      ]
    },
    {
      "name": "DeleteProbeTask",
      "description": "删除拨测任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIds",
          "type": "array",
          "required": true,
          "description": "任务 ID",
          "example": "[\"task-xx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "TaskIds"
      ]
    },
    {
      "name": "DescribeDetailedSingleProbeData",
      "description": "根据时间范围、任务ID、运营商等条件查询单次拨测详情数据",
      "status": "online",
      "parameters": [
        {
          "name": "BeginTime",
          "type": "integer",
          "required": true,
          "description": "开始时间戳（毫秒级）",
          "example": "1000000000"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间戳（毫秒级）",
          "example": "1000000000"
        },
        {
          "name": "TaskType",
          "type": "string",
          "required": true,
          "description": "任务类型 AnalyzeTaskType_Network：网络质量 AnalyzeTaskType_Browse：页面性能 AnalyzeTaskType_UploadDownload：文件传输（含文件上传、文件下载） AnalyzeTaskType_Transport：端口性能 AnalyzeTaskType_MediaStream：音视频体验",
          "example": "AnalyzeTaskType_UploadDownload"
        },
        {
          "name": "SortField",
          "type": "string",
          "required": true,
          "description": "待排序字段 可以填写 ProbeTime 拨测时间排序 也可填写SelectedFields 中的选中字段",
          "example": "ProbeTime"
        },
        {
          "name": "Ascending",
          "type": "boolean",
          "required": true,
          "description": "true表示升序",
          "example": "true"
        },
        {
          "name": "SelectedFields",
          "type": "array",
          "required": true,
          "description": "选中字段，如ProbeTime、TransferTime、TransferSize等。",
          "example": "[\"ProbeTime\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "起始取数位置",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "取数数量",
          "example": "10"
        },
        {
          "name": "TaskID",
          "type": "array",
          "required": false,
          "description": "任务ID",
          "example": "[\"task_fasdfds\"]",
          "item_type": "string"
        },
        {
          "name": "Operators",
          "type": "array",
          "required": false,
          "description": "拨测点运营商 这里实际按拨测结果中的运营商来填写即可 电信：中国电信 移动：中国移动 联通：中国联通",
          "example": "[\"电信\"]",
          "item_type": "string"
        },
        {
          "name": "Districts",
          "type": "array",
          "required": false,
          "description": "拨测点地区 这里实际按拨测结果中的地区来填写即可 国内一般是省级单位，如广东、广西、中国香港；直辖市则填北京、上海 境外一般是国家名，如澳大利亚、新加坡",
          "example": "[\"上海\"]",
          "item_type": "string"
        },
        {
          "name": "ErrorTypes",
          "type": "array",
          "required": false,
          "description": "错误类型",
          "example": "[\"正常\"]",
          "item_type": "string"
        },
        {
          "name": "City",
          "type": "array",
          "required": false,
          "description": "城市 这里实际按拨测结果中的城市来填写即可 示例： 深圳市 武汉市 首尔 多伦多",
          "example": "[\"深圳市\"]",
          "item_type": "string"
        },
        {
          "name": "ScrollID",
          "type": "string",
          "required": false,
          "description": "es scroll查询id",
          "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAQEPczgWVU1RMC12VHhSUWlYa1I0dnU4aXlvUQ=="
        },
        {
          "name": "QueryFlag",
          "type": "string",
          "required": false,
          "description": "详情数据下载",
          "example": "\"download\""
        }
      ],
      "required": [
        "BeginTime",
        "EndTime",
        "TaskType",
        "SortField",
        "Ascending",
        "SelectedFields",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeInstantTasks",
      "description": "获取历史即时拨测任务",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "数量",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "起始位置",
          "example": "1"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeNodeGroups",
      "description": "获取拨测点组（可用性拨测点组、高级拨测点组、我的拨测点组）",
      "status": "online",
      "parameters": [
        {
          "name": "NodeType",
          "type": "array",
          "required": false,
          "description": "节点类型。0: 全部 1: IDC 2: LastMile 3: Mobile，不填默认为0",
          "example": "[1, 2]",
          "item_type": "integer"
        },
        {
          "name": "TaskCategory",
          "type": "integer",
          "required": false,
          "description": "节点分类。0: 全部 1: PC 2：Mobile，不填默认为0。PC分类包括IDC和LM节点类型，Mobile分类包括Mobile节点类型。与NodeType参数取交集。",
          "example": "1"
        },
        {
          "name": "IPType",
          "type": "integer",
          "required": false,
          "description": "IP类型。0: 全部 1: IPv4 2: IPv6，不填默认为0",
          "example": "1"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "拨测点描述关键词。",
          "example": "广州"
        },
        {
          "name": "RegionID",
          "type": "integer",
          "required": false,
          "description": "地域ID。0: 精选拨测点 1: 国内 2: 港澳台 3: 亚太 4: 欧洲与美洲 5: 非洲与大洋洲，不填默认为0",
          "example": "1"
        },
        {
          "name": "DistrictID",
          "type": "integer",
          "required": false,
          "description": "省份或国家ID。0表示全部，不填默认为0",
          "example": "1"
        },
        {
          "name": "NetServiceID",
          "type": "integer",
          "required": false,
          "description": "运营商ID。0: 全部 1: 中国电信 2: 中国联通 3: 中国移动 99: 其他，不填默认为0",
          "example": "1"
        },
        {
          "name": "NodeGroupType",
          "type": "integer",
          "required": false,
          "description": "节点组类型。0: 高级拨测点组 1: 可用性节点 2: 我的拨测点组，不填默认为0",
          "example": "1"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "任务类型，如1、2、3、4、5、6、7；1-页面性能、2-文件上传、3-文件下载、4-端口性能、5-网络质量、6-音视频体验、7-域名whois，不填默认为0，不对任务类型做过滤",
          "example": "1"
        },
        {
          "name": "ProbeType",
          "type": "integer",
          "required": false,
          "description": "测试类型，包含定时测试与即时测试。0-定时拨测，其它表示即时拨测。",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeNodes",
      "description": "获取拨测节点",
      "status": "online",
      "parameters": [
        {
          "name": "NodeType",
          "type": "integer",
          "required": false,
          "description": "节点类型 1 = IDC 2 = LastMile 3 = Mobile",
          "example": "1"
        },
        {
          "name": "Location",
          "type": "integer",
          "required": false,
          "description": "节点区域 1 = 中国大陆 2 = 港澳台 3 = 境外",
          "example": "1"
        },
        {
          "name": "IsIPv6",
          "type": "boolean",
          "required": false,
          "description": "是否IPv6",
          "example": "false"
        },
        {
          "name": "NodeName",
          "type": "string",
          "required": false,
          "description": "名字模糊搜索",
          "example": "沈阳"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": false,
          "description": "付费模式 1 = 试用版本 2 = 付费版本",
          "example": "1"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "任务类型 1 = 页面性能 2 = 文件上传 3 = 文件下载 4 = 端口性能 5 = 网络质量 6 = 音视频体验",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProbeMetricData",
      "description": "查询云拨测指标数据，指标支持使用sum,avg,max,min聚合函数进行指标数据查询 拨测频率与groupby聚合时间设置关联，如拨测频率为 30 分钟，则 grouby 聚合时间建议设置为大于30分钟，避免出现查询数据为空的情况",
      "status": "online",
      "parameters": [
        {
          "name": "AnalyzeTaskType",
          "type": "string",
          "required": false,
          "description": "分析任务类型，支持以下几种类型： AnalyzeTaskType_Network：网络质量 AnalyzeTaskType_Browse：页面性能 AnalyzeTaskType_Transport：端口性能 AnalyzeTaskType_UploadDownload：文件传输 AnalyzeTaskType_MediaStream：音视频体验",
          "example": "AnalyzeTaskType_UploadDownload"
        },
        {
          "name": "MetricType",
          "type": "string",
          "required": false,
          "description": "指标类型（counter、gauge以及histogram），指标查询默认传gauge",
          "example": "gauge"
        },
        {
          "name": "Field",
          "type": "string",
          "required": false,
          "description": "指标详细字段，可以传递传具体的指标也可以对指标进行聚合查询例如：\"avg(ping_time)\"代表整体时延(ms)；不同的任务类型支持不同的field查询，以及聚合规则，详情可见https://cloud.tencent.com/document/product/248/87584。",
          "example": "avg(ping_time)"
        },
        {
          "name": "Filter",
          "type": "string",
          "required": false,
          "description": "过滤条件可以传单个过滤条件也可以拼接多个参数",
          "example": "host = '123' and time \u003e= now()-30m"
        },
        {
          "name": "GroupBy",
          "type": "string",
          "required": false,
          "description": "聚合时间, 1m、1d、30d 等等",
          "example": "time(1m),  operator"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "多条件过滤，支持多个过滤条件组合查询 例如：[\"\"host\" = 'www.test.com'\", \"time \u003e= now()-1h\"]",
          "example": "[\"host\" = 'https://test.com'\", \"time \u003e= now()-1h\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProbeMetricTagValues",
      "description": "查询同个任务类型下的维度标签值，包括查询用户任务信息，具体任务下的多个维度标签信息。（通过为DescribeProbeMetricData接口的Filters参数添加维度筛选条件，可实现多维数据分析）",
      "status": "online",
      "parameters": [
        {
          "name": "AnalyzeTaskType",
          "type": "string",
          "required": false,
          "description": "分析任务类型，支持以下几种类型： AnalyzeTaskType_Network：网络质量 AnalyzeTaskType_Browse：页面性能 AnalyzeTaskType_Transport：端口性能 AnalyzeTaskType_UploadDownload：文件传输 AnalyzeTaskType_MediaStream：音视频体验",
          "example": "AnalyzeTaskType_UploadDownload"
        },
        {
          "name": "Key",
          "type": "string",
          "required": false,
          "description": "维度标签值，参考： host：任务域名 errorInfo：状态类型 area：拨测点地区 operator：拨测点运营商 taskId：任务ID",
          "example": "host"
        },
        {
          "name": "Filter",
          "type": "string",
          "required": false,
          "description": "过滤条件，可以传单个过滤条件也可以拼接多个参数，支持正则匹配",
          "example": "host = 'www.qq.com' and taskId =~ /^(task-probe123)$/"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件数组",
          "example": "[\"\"]",
          "item_type": "string"
        },
        {
          "name": "TimeRange",
          "type": "string",
          "required": false,
          "description": "时间范围",
          "example": "time \u003e= now()-1h"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProbeNodes",
      "description": "查询拨测节点",
      "status": "online",
      "parameters": [
        {
          "name": "NodeType",
          "type": "integer",
          "required": false,
          "description": "节点类型 1 = IDC 2 = LastMile 3 = Mobile",
          "example": "1"
        },
        {
          "name": "Location",
          "type": "integer",
          "required": false,
          "description": "节点区域 1 = 中国大陆 2 = 港澳台 3 = 海外",
          "example": "1"
        },
        {
          "name": "IsIPv6",
          "type": "boolean",
          "required": false,
          "description": "是否IPv6",
          "example": "false"
        },
        {
          "name": "NodeName",
          "type": "string",
          "required": false,
          "description": "名字模糊搜索",
          "example": "沈阳"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": false,
          "description": "付费模式 1 = 试用版本 2 = 付费版本",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProbeTasks",
      "description": "查询拨测任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIDs",
          "type": "array",
          "required": false,
          "description": "任务 ID 列表",
          "example": "[\"task-xx\"]",
          "item_type": "string"
        },
        {
          "name": "TaskName",
          "type": "string",
          "required": false,
          "description": "任务名",
          "example": "probe"
        },
        {
          "name": "TargetAddress",
          "type": "string",
          "required": false,
          "description": "拨测目标",
          "example": "http://www.qq.com"
        },
        {
          "name": "TaskStatus",
          "type": "array",
          "required": false,
          "description": "任务状态列表 1 = 创建中 2 = 运行中 3 = 运行异常 4 = 暂停中 5 = 暂停异常 6 = 任务暂停 7 = 任务删除中 8 = 任务删除异常 9 = 任务删除 10 = 定时任务暂停中",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100",
          "example": "10"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": false,
          "description": "付费模式 1 = 试用版本 2 = 付费版本",
          "example": "1"
        },
        {
          "name": "OrderState",
          "type": "integer",
          "required": false,
          "description": "订单状态 1 = 正常 2 = 欠费",
          "example": "1"
        },
        {
          "name": "TaskType",
          "type": "array",
          "required": false,
          "description": "拨测类型 1 = 页面浏览 2 =文件上传 3 = 文件下载 4 = 端口性能 5 = 网络质量 6 =流媒体 即使拨测只支持页面浏览，网络质量，文件下载",
          "example": "[1,2,3]",
          "item_type": "integer"
        },
        {
          "name": "TaskCategory",
          "type": "array",
          "required": false,
          "description": "节点类型",
          "example": "[1,2,3]",
          "item_type": "integer"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序的列",
          "example": "task_category"
        },
        {
          "name": "Ascend",
          "type": "boolean",
          "required": false,
          "description": "是否正序",
          "example": "true"
        },
        {
          "name": "TagFilters",
          "type": "array",
          "required": false,
          "description": "资源标签值",
          "example": "[{\"Key\":\"name\", \"Value\": \"zhangsan\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "健",
              "example": "Name"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "值",
              "example": "zhangsan"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "ResumeProbeTask",
      "description": "恢复拨测任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIds",
          "type": "array",
          "required": true,
          "description": "任务 ID",
          "example": "[\"task-xx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "TaskIds"
      ]
    },
    {
      "name": "SuspendProbeTask",
      "description": "暂停任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIds",
          "type": "array",
          "required": true,
          "description": "任务 ID",
          "example": "[\"task-xx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "TaskIds"
      ]
    },
    {
      "name": "UpdateProbeTaskAttributes",
      "description": "更新探测任务属性",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务 ID",
          "example": "task-xx"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "任务名，该参数为空时不作任何修改。",
          "example": "update_task_attributes"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "UpdateProbeTaskConfigurationList",
      "description": "批量更新拨测任务配置",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIds",
          "type": "array",
          "required": true,
          "description": "任务 ID，如task-n1wchki8",
          "example": "task-xx",
          "item_type": "string"
        },
        {
          "name": "Nodes",
          "type": "array",
          "required": true,
          "description": "拨测节点，如10001，详细地区运营商拨测编号请联系云拨测。",
          "example": "[\"10001\"]",
          "item_type": "string"
        },
        {
          "name": "Interval",
          "type": "integer",
          "required": true,
          "description": "拨测间隔，如30，单位为分钟。",
          "example": "30"
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": true,
          "description": "拨测参数，详细参数配置可参考云拨测官网文档。",
          "example": "{\\\"ipType\\\":0,\\\"grabBag\\\":0,\\\"netIcmpOn\\\":1,\\\"netIcmpActivex\\\":0,\\\"netIcmpTimeout\\\":20,\\\"netIcmpInterval\\\":0.5,\\\"netIcmpNum\\\":20,\\\"netIcmpSize\\\":32,\\\"netIcmpDataCut\\\":1}"
        },
        {
          "name": "Cron",
          "type": "string",
          "required": false,
          "description": "定时任务cron表达式",
          "example": "* 0-5 * * *"
        },
        {
          "name": "ResourceIDs",
          "type": "array",
          "required": false,
          "description": "预付费套餐id 需要与taskId对应",
          "example": "[\"presub-xx\"]",
          "item_type": "string"
        },
        {
          "name": "NodeIpType",
          "type": "integer",
          "required": false,
          "description": "拨测节点的IP类型，0-不限，1-IPv4，2-IPv6",
          "example": "0"
        },
        {
          "name": "BatchTasks",
          "type": "array",
          "required": false,
          "description": "批量任务名-地址",
          "example": "TargetAddress: \"www.qq.com\", Name: \"test\"",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "拨测任务名称",
              "example": "probe-task1"
            },
            {
              "name": "TargetAddress",
              "type": "string",
              "required": true,
              "description": "拨测目标地址",
              "example": "www.baidu.com"
            }
          ]
        }
      ],
      "required": [
        "TaskIds",
        "Nodes",
        "Interval",
        "Parameters"
      ]
    }
  ]
}