有奖捉虫:云通信与企业服务文档专题,速来> HOT

DetailedSingleDataDefine

单条详细拨测数据

被如下接口引用:DescribeDetailedSingleProbeData。

名称 类型 描述
ProbeTime Integer 拨测时间戳
示例值:1000000000
Labels Array of Label 储存所有string类型字段
示例值:[{...}, {...}]
Fields Array of Field 储存所有float类型字段
示例值:[{...},{...}]

Field

储存float类型字段

被如下接口引用:DescribeDetailedSingleProbeData。

名称 类型 描述
ID Integer 自定义字段编号
示例值:1
Name String 自定义字段名称/说明
示例值:probeTime
Value Float 字段值
示例值:10000000000

KeyValuePair

健值对

被如下接口引用:DescribeProbeTasks。

名称 类型 必选 描述
Key String
示例值:Name
Value String
示例值:zhangsan

Label

保存string类型字段

被如下接口引用:DescribeDetailedSingleProbeData。

名称 类型 描述
ID Integer 自定义字段编号
示例值:1
Name String 自定义字段名称/说明
示例值:probeIP
Value String 字段值
示例值:0.0.0.0

NodeDefine

探测节点

被如下接口引用:DescribeProbeNodes。

名称 类型 描述
Name String 节点名称
示例值:中国电信-北京 IDC
Code String 节点代码
示例值:10001
Type Integer 节点类型
  • 1 = IDC
  • 2 = LastMile
  • 3 = Mobile

  • 示例值:1
    NetService String 网络服务商
    示例值:中国移动
    District String 区域
    示例值:福建
    City String 城市
    示例值:宁德市
    IPType Integer IP 类型
  • 1 = IPv4
  • 2 = IPv6

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Location Integer 区域
  • 1 = 中国大陆
  • 2 = 港澳台
  • 3 = 国外

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    CodeType String 节点类型 如果为base 则为可用性拨测点,为空则为高级拨测点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:base
    NodeDefineStatus Integer 节点状态:1-运行,2-下线
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    NodeDefineExt

    探测节点

    被如下接口引用:DescribeNodes。

    名称 类型 描述
    Name String 节点名称
    示例值:中国电信-北京 IDC
    Code String 节点代码
    示例值:10001
    Type Integer 节点类型
  • 1 = IDC
  • 2 = LastMile
  • 3 = Mobile

  • 示例值:1
    NetService String 网络服务商
    示例值:中国移动
    District String 区域
    示例值:福建
    City String 城市
    示例值:宁德市
    IPType Integer IP 类型
  • 1 = IPv4
  • 2 = IPv6

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Location Integer 区域
  • 1 = 中国大陆
  • 2 = 港澳台
  • 3 = 境外

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    CodeType String 节点类型 如果为base 则为可用性拨测点,为空则为高级拨测点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:base
    TaskTypes Array of Integer 节点支持的任务类型。1: 页面性能 2: 文件上传 3: 文件下载 4: 端口性能 5: 网络质量 6: 音视频体验
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1, 2, 3]

    ProbeTask

    拨测任务

    被如下接口引用:DescribeProbeTasks。

    名称 类型 描述
    Name String 任务名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:probe
    TaskId String 任务 ID
    示例值:task-xx
    TaskType Integer 拨测类型
  • 1 = 页面浏览
  • 2 =文件上传
  • 3 = 文件下载
  • 4 = 端口性能
  • 5 = 网络质量
  • 6 =流媒体


  • 即时拨测只支持页面浏览,网络质量,文件下载
    示例值:1
    Nodes Array of String 拨测节点列表
    示例值:["10000"]
    NodeIpType Integer 拨测任务所选的拨测点IP类型,0-不限,1-IPv4,2-IPv6
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Interval Integer 拨测间隔
    示例值:30
    Parameters String 拨测参数
    示例值:{}
    Status Integer 任务状态
  • 1 = 创建中
  • 2 = 运行中
  • 3 = 运行异常
  • 4 = 暂停中
  • 5 = 暂停异常
  • 6 = 任务暂停
  • 7 = 任务删除中
  • 8 = 任务删除异常
  • 9 = 任务删除
  • 10 = 定时任务暂停中

  • 示例值:1
    TargetAddress String 目标地址
    示例值:http://www.qq.com
    PayMode Integer 付费模式
  • 1 = 试用版本
  • 2 = 付费版本

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

  • 示例值:1
    TaskCategory Integer 任务分类
  • 1 = PC
  • 2 = Mobile

  • 示例值:1
    CreatedAt String 创建时间
    示例值:"2020"
    Cron String 定时任务cron表达式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:* 0-5 * * *
    CronState Integer 定时任务启动状态
  • 1 = 定时任务表达式生效
  • 2 = 定时任务表达式未生效(一般为任务手动暂停)

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    TagInfoList Array of KeyValuePair 任务当前绑定的标签
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{"Key":"name", "Value": "zhangsan"}]

    ProbeTaskBasicConfiguration

    拨测任务基础配置

    被如下接口引用:CreateProbeTasks。

    名称 类型 必选 描述
    Name String 拨测任务名称
    示例值:probe-task1
    TargetAddress String 拨测目标地址
    示例值:www.baidu.com

    SingleInstantTask

    单个即时拨测任务信息

    被如下接口引用:DescribeInstantTasks。

    名称 类型 描述
    TaskId String 任务ID
    示例值:task-123
    TargetAddress String 任务地址
    示例值:http://qq.com
    TaskType Integer 任务类型
    示例值:5
    ProbeTime Integer 测试时间
    示例值:1641917822000
    Status String 任务状态
    示例值:成功
    SuccessRate Float 成功率
    示例值:0.8
    NodeCount Integer 节点数量
    示例值:1
    TaskCategory Integer 节点类型
    示例值:1

    Tag

    资源的标签,通过标签对资源进行划分用于支持细粒度的鉴权、分账等场景

    被如下接口引用:CreateProbeTasks。

    名称 类型 必选 描述
    TagKey String key
    示例值:k
    TagValue String value
    示例值:v

    TaskResult

    任务执行结果

    被如下接口引用:DeleteProbeTask, ResumeProbeTask, SuspendProbeTask。

    名称 类型 描述
    TaskId String 任务 ID
    示例值:task-xx
    Success Boolean 是否成功
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    ErrorMessage String 错误信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:错误信息