数据结构

最近更新时间:2020-02-27 11:22:21

AgentGroup

拨测分组

被如下接口引用:DescribeAgentGroups。

名称 类型 必选 描述
GroupId Integer 拨测分组ID
GroupName String 拨测分组名称
IsDefault Integer 是否默认拨测分组。1表示是,0表示否
TaskNum Integer 使用本拨测分组的任务数
GroupDetail Array of CatAgent 拨测结点列表
MaxGroupNum Integer 最大拨测分组数

AlarmInfo

拨测告警信息

被如下接口引用:DescribeAlarms、DescribeAlarmsByTask。

名称 类型 必选 描述
ObjName String 告警对象的名称
FirstOccurTime String 告警发生的时间
LastOccurTime String 告警结束的时间
Status Integer 告警状态。1 表示已恢复,0 表示未恢复,2表示数据不足
Content String 告警的内容
TaskId Integer 拨测任务ID
MetricName String 特征项名字
MetricValue String 特征项数值
ObjId String 告警对象的ID

AlarmTopic

告警主题

被如下接口引用:DescribeAlarmTopic。

名称 类型 描述
TopicId String 主题的ID
TopicName String 主题的名称

CatAgent

拨测Agent 所在省份、运营商

被如下接口引用:CreateAgentGroup、DescribeAgentGroups、DescribeAgents、ModifyAgentGroup。

名称 类型 必选 描述
Province String 拨测结点所在的省份(拼音缩写)
Isp String 拨测结点所在的运营商(英文缩写)
ProvinceName String 拨测结点所在的省份(中文名称)
注意:此字段可能返回 null,表示取不到有效值。
IspName String 拨测结点所在的运营商(中文名称)
注意:此字段可能返回 null,表示取不到有效值。

CatLog

拨测记录

被如下接口引用:DescribeCatLogs。

名称 类型 描述
Time Timestamp 拨测时间点
CatTypeName String 拨测类型
TaskId Integer 任务ID
City String 拨测点所在城市
Isp String 拨测点所在运营商
ServerIp String 被拨测Server的IP
DomainName String 被拨测Server的域名
TotalTime Integer 执行耗时,单位毫秒
ResultType Integer 成功失败(1 失败,0 成功)
ResultCode Integer 失败错误码
ReqPkgSize Integer 请求包大小
RspPkgSize Integer 回应包大小
ReqMsg String 拨测请求
RespMsg String 拨测回应
ClientIp String 客户端IP
CityName String 拨测点所在城市名称
IspName String 拨测点所在运营商名称
ParseTime Integer 解析耗时,单位毫秒
ConnectTime Integer 连接耗时,单位毫秒
SendTime Integer 数据发送耗时,单位毫秒
WaitTime Integer 等待耗时,单位毫秒
ReceiveTime Integer 接收耗时,单位毫秒

CatReturnDetail

拨测失败详情

被如下接口引用:GetReturnCodeHistory、GetReturnCodeInfo。

名称 类型 描述
IspName String 运营商名称
Province String 省份全拼
ProvinceName String 省份中文名称
MapKey String Map键值
ServerIp String 拨测目标的IP
ResultCount Integer 拨测失败个数
ResultCode Integer 拨测失败返回码
ErrorReason String 拨测失败原因描述

CatReturnSummary

拨测失败返回情况汇总

被如下接口引用:GetReturnCodeHistory、GetReturnCodeInfo。

名称 类型 描述
ResultCount Integer 拨测失败个数
ResultCode Integer 拨测失败返回码
ErrorReason String 拨测失败原因描述

CatTaskDetail

任务信息和告警策略组

被如下接口引用:DescribeTaskDetail。

名称 类型 必选 描述
TaskId Integer 任务ID
TaskName String 任务名称
Period Integer 任务周期,单位为分钟。目前支持1,5,15,30几种取值
CatTypeName String 拨测类型。http, https, ping, tcp 之一
CgiUrl String 拨测任务的URL
AgentGroupId Integer 拨测分组ID
PolicyGroupId Integer 告警策略组ID
Status Integer 任务状态。1表示暂停,2表示运行中,0为初始态
AddTime Timestamp 任务创建时间
Type Integer 任务类型。0 站点监控,2 可用性监控
TopicId String 绑定的统一告警主题ID
AlarmStatus Integer 告警状态。0 未启用,1, 启用
Host String 指定的域名
Port Integer 拨测目标的端口号
CheckStr String 要在结果中进行匹配的字符串
CheckType Integer 1 表示通过检查结果是否包含CheckStr 进行校验
UserAgent String 用户Agent信息
Cookie String 设置的Cookie信息
PostData String POST 请求数据。空字符串表示非POST请求
SslVer String SSL协议版本
IsHeader Integer 是否为Header请求。非0 Header 请求
DnsSvr String 目的DNS服务器
DnsCheckIp String 需要检验是否在DNS IP列表的IP
DnsQueryType String DNS查询类型
UserName String 登录服务器的账号
PassWord String 登录服务器的密码
UseSecConn Integer 是否使用安全链接SSL, 0 不使用,1 使用
NeedAuth Integer FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
ReqDataType Integer 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
ReqData String 发起TCP, UDP请求的协议请求数据
RespDataType Integer 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
RespData String 预期的UDP请求的回应数据
RedirectFollowNum Integer 跟随跳转次数

DataPoint

时延等数据,数据点

被如下接口引用:GetRespTimeTrendEx。

名称 类型 描述
LogTime Timestamp 数据点的时间
MetricValue Float 数据值

DataPointMetric

包含MetricName的DataPoint数据

被如下接口引用:GetRespTimeTrendEx。

名称 类型 描述
MetricName String 数据项
Points Array of DataPoint 数据点的时间和值

DimensionsDetail

拨测点维度信息

被如下接口引用:GetRespTimeTrendEx。

名称 类型 必选 描述
Isp Array of String 运营商列表
Province Array of String 省份列表

IspDetail

运营商可用率

被如下接口引用:GetAvailRatioHistory、GetDailyAvailRatio、GetRealAvailRatio。

名称 类型 描述
IspName String 运营商名称
AvailRatio Float 可用率
AvgTime Float 平均耗时
注意:此字段可能返回 null,表示取不到有效值。

ProvinceDetail

省份可用率

被如下接口引用:GetAvailRatioHistory、GetDailyAvailRatio、GetRealAvailRatio。

名称 类型 描述
AvgAvailRatio Float 可用率
ProvinceName String 省份名称
Mapkey String 省份英文名称
TimeStamp Timestamp 统计时间点
IspDetail Array of IspDetail 分运营商可用率
AvgTime Float 平均耗时,单位毫秒
Province String 省份

ResultSummary

实时统计数据

被如下接口引用:GetResultSummary。

名称 类型 描述
LogTime Timestamp 统计时间
TaskId Integer 任务ID
AvailRatio Float 实时可用率
ReponseTime Float 实时响应时间

TaskAlarm

可用性监控任务状态及告警信息

被如下接口引用:DescribeTasksByType。

名称 类型 描述
TaskId Integer 任务ID
TaskName String 任务名称
Period Integer 任务周期,单位为分钟。目前支持1,5,15,30几种取值
CatTypeName String 拨测类型。http, https, ping, tcp, udp, smtp, pop3, dns 之一
Status Integer 任务状态。1表示暂停,2表示运行中,0为初始态
CgiUrl String 拨测任务的URL
AddTime Timestamp 任务创建时间
AlarmStatus Integer 告警状态。1 故障,0 正常
StatusInfo String 告警状态描述,统计信息
UpdateTime Timestamp 任务更新时间