接口规范说明
接口前提参数规则
开放api接口域名
接口响应状态码与错误码说明
基础信息描述
基础信息
获取访问开放api的token
地区基础信息
运营商基础信息
用户可以使用的监测点列表
获取任务正在使用的监测点信息
任务管理
基础信息
任务创建
任务修改
任务删除
任务详情
任务开启
任务暂停
任务列表
告警管理
创建任务的自定义告警规则
修改任务的自定义告警规则
删除任务的自定义告警规则
查看任务的自定义告警规则
创建任务告警通知
修改任务告警通知
获取任务告警通知
删除任务告警通知
历史快照数据
查看历史快照列表
查看单次历史快照详情
查看单次快照中的响应结果
任务故障
任务所有监测点的故障记录
任务单个监测点故障记录
任务单个监测点故障次数
告警消息
消息列表
响应时间与可用率
任务所有监测点的统计汇总数据
任务平均响应时间刻度数据
任务平均响应时间详细统计刻度数据
任务平均可用率刻度数据
traceroute任务跳数统计刻度数据
获取任务最近一次监测结果数据
监测点分组管理
账号监测点分组列表
获取监测点分组信息
修改监测点分组信息
添加监测点分组信息
删除监测点分组信息
用户管理
获取用户基本信息
修改用户基本信息
创建用户
删除用户
当前账户信息
获取当前账户信息
账号公共设置
获取当前账户下用户列表
获取当前账户套餐信息
用户分组管理
用户分组列表
添加用户分组
修改用户分组
删除用户分组
获取单个分组下的用户
获取多个分组下的用户
将用户添加入分组
附录
附录一 siteapi错误编码与含义
附录二 userapi错误编码与含义

<接口地址>:/siteapi/tasks/threshold/


<请求方式>:POST


<请求类型>:JSON


<响应类型>:JSON


<请求参数>:

指标名称

是否必须

数据类型

默认值

描述

task_id

Int


任务ID

 setting

array


自定义告警设置

value

Int


告警阈值

status

Int


状态[0-开启,1-暂停]

DNS特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

DNS特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

DNS特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

FTP特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

FTP特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

FTP特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

TCP特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

TCP特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

TCP特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

UDP特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

UDP特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

UDP特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

HTTP特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于,2-小于]

unit

Int


单位 [1-ms,2-s]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

HTTP特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

HTTP特殊参数-响应状态码

metric

Int


告警指标[5-响应状态码]

cond

Int


条件 [7-等于]

value

Int


[301,302,400,401,502,503,504]

unit

Int


单位 [4-无单位]

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

HTTP特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

Ping特殊参数-不可用监测点

metric

Int


告警指标[4-不可用监测点]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

Ping特殊参数-当前响应时间

metric

Int


告警指标[1-当前响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

Ping特殊参数-当前丢包率

metric

Int


告警指标[2-当前丢包率]

cond

Int


条件 [1-大于]

unit

Int


单位 [3-%]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

monitor_set

Int


针对分布式监测点[1-任意几个监测点,2-指定检测点,3-平均]

monitor_count

Int


监测点个数monitor_set设置为1时必须填写

dev

array


指定检测的数组[monitor_set设置为2时必须填写]

Ping特殊参数-当日可用率

metric

Int


告警指标[3-当日可用率]

cond

Int


条件 [2-小于]

unit

Int


单位 [3-%]

TraceRoute特殊参数-总跳数

metric

Int


告警指标[300-总跳数]

cond

Int


条件 [1-大于]

unit

Int


单位 [4-无单位]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

monitor_trigger_type

Int


触发类型[1,2],1为相同监测点,2为不同监测点;当advance_status为1,且monitor_set为1时为必填字段

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

TraceRoute特殊参数-不响应跳数

metric

Int


告警指标[301-不响应跳数]

cond

Int


条件 [1-大于]

unit

Int


单位 [4-无单位]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

TraceRoute特殊参数-丢包跳数比

metric

Int


告警指标[302-丢包跳数比]

cond

Int


条件 [1-大于]

unit

Int


单位 [3-%]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

TraceRoute特殊参数-响应时间

metric

Int


告警指标[303-响应时间]

cond

Int


条件 [1-大于]

unit

Int


单位 [1-ms]

advanced_status

Int


高级告警策略[1,2],1为开启,2为关闭

retry

Int


连续触发几次即告警[2,3];当advance_status为1时为必填字段

 

<请求示例>:

{
    "task_id": 684351,
    "setting": [
        {
            "metric": 1,
            "cond": 1,
            "unit": 1,
            "value": 200,
            "status": 0,
            "retry": 3,
            "monitor_set": 2,
            "dev": [
                1,
                2
            ]
        },
        ...............
    ]
}


<响应数据>:

参数名称

数据类型

描述

th_id

Array

成功创建返回的告警线id数组


<响应示例>:

{
    "th_id": [
        118189
    ]
}