报警接口API说明

报警接口API说明

目录

报警接口API说明..................................................................1

1创建报警........................................................................3

URL例：......................................................................3

请求参数说明：...............................................................3

POST字段说明：..............................................................3

基本参数：...............................................................3

报警条件：...............................................................4

报警规则：...............................................................5

监测点配置规则：.........................................................6

报警方式：...............................................................6

报警方式一邮件：.........................................................7

报警方式―短信：.........................................................7

响应参数说明：...............................................................7

权限说明：....................................................................8

2更新报警........................................................................8

URL例：......................................................................8

请求参数说明：...............................................................8

PUT参数说明：...............................................................9

响应参数说明：...............................................................9

权限说明：....................................................................9

3删除报警........................................................................9

URL例：......................................................................9

请求参数说明：...............................................................9

响应参数说明：..............................................................10

权限说明：...................................................................10

4查询报警.......................................................................10

URL例：.....................................................................10

请求参数说明：..............................................................10

响应参数说明：..............................................................11

权限说明：...................................................................11

5查询报警日志列表...............................................................12

URL例：.....................................................................12

请求参数说明：..............................................................12

响应参数说明：..............................................................14

权限说明：...................................................................14

6获取单个报警日志详情..........................................................14

URL例：.....................................................................14

请求参数说明：..............................................................15

响应参数说明：..............................................................15

权限说明：...................................................................15

1创建报三

URL例：

请求地址：

:8089/DML/ALERT

创建url

:8089/DML/ALERT?userName=***&password=***&POST=role_id,alertname&typeld=l&monitor

_fun=l&role_id=170453&alertname=aaa

请求参数说明:

参数名类型为空描述

userNameString否用户名

passwordString否密码，以md5加密（小写）

POSTString否要插入的字段序列，以逗号分隔

POST字段对应值String否POST中出现的所有字段，在url中必须给以

“&列=值”的方式出对应值

typeldNumber否1

POST字段说明:

基本参数：

字段名类型为空描述/备注

ALERTNAMEString否报警名称

Max=200

ROLE_IDNumber否任务id

MONITOR_FUNNumber否监测类型：1网络环境，2浏览/事务，4下载，5

流媒体,6元素组，7私有协议99-移动单元素，98

移动私有协议，97移动网络，96移动全元素

ALERT_TYPENumber否报警类型：0—按监测点；1一按目标主机

报警条件:

字段名类型为空描述/备注

ALERT_CONDITION1String可报瞥指标阈值配置，详见指标配置说明

Max二1000

指标配置说明:

指标X：{

p:'普通阈值'，

y：'严重阈值'，

m:是否为必要条件,

j：大小标示

},

指标Y:{

P：'普通阈值'，

y：‘严重阈值'，

m：是否为必要条件,

j：大小标示

)

例：

{FIRST_TIME:{p:"0.1",y:"0.2"zm:0J:l}/USEABLE:{p:"90",y:"8C",m:0,j:0}}

注：

P后为普通报警阈值

Y后为严重报警阈值

M标示是否为必要条件0-非必要条件1•必要条件

J大小标小，0—越小越差1—越大越差

可选指标:

浏览/事务:

指标名指标项

D_T1ME整体性能

报警规则:

字段名类型为空描述/备注

DATA_INTERVALNumber否数据收集周期数，任务频率的倍数

CYCLE_NUMNumber可本报警周期每城市运营商最低样本数阈值

CYCLEPERCENTNumber可触发报警条数%（一个检测周期内实际检测数量与

预计数量的百分比（满足此条件判断报警）默认

50）

FIDNumber可筛选器ID

MONITORSString否报警监测点范围，多个以逗号分隔，详细规则见

监测点配置说明《

MONITOR_PERCENTNumber可报警个数阈值，在按城市运营商、主机、域名分

别计算报警后，达到次阈值报警

ALERT_INTERVALNumber否报警间隔（劫持报警发送周期）

ONLINE_NUMNumbar可本周期出现报警的城市运营商即时测试样本补偿

次数

SMS_IS_NOTICENumber可解除报警是否发短信1-发0-不发

KEY_ELEMENT_URLString可关键兀素URL

KEYELEMENTNAMEString可关键元素名称

监测点配置规则：

规则：

城市编码—运营商编码」DC/LM标示,

例：

北京电信ide,上海联通lastmail

1100101_1_1,1100201_2_2

注：

城市编码、运营商编码，见详细的编码表格《城市编码》《运营商编码》

ldc>Im标示：1—IDC2—Lastmail3—mob

报警方式:

字段名类型为空描述/备注

LANGUAGENumber可报警内容语言版本0：中文；1：英文

报警方式-邮件:

字段名类型为描述/备注

空

NORMAL_MAIL_NAMEString可普通级别接受者邮件（，分割）

SERIOUSMAILNAMEString可严重级别接受者邮件（,分割）

MAIL_TYPENumber可邮件类型，0—缺省bonree邮件服务器；1一用户

自定义邮件服务器

MAILSERVERURLString可邮件server的smtp地址

MAIL_SERVER_NAMEString可邮件服务器用户名

MAIL_SERVER_PWDString可邮件服务器密码

报警方式-短信:

字段名类型为空描述/备注

NORMALPHONENUMString可普通级别接受者手机号码（，分割）

SERIOUS_PHONENUMString可严重级别接受者手机号码（，分割）

SMS_LENGTHNumoer可短信长度

SMSFORMATString可用户配置发送短信的内容格式

SMS_TYPENumoer可0缺省短信网关，1一用户自定义短信网关

SMS_URLString可短信自定义网关地址

SMSSTARTHOURNumoer可短信报警起始时间

SMS_END_HOURNumoer可短信报警结束时间

响应参数说明:

成功：{}

失败：｛9rror?对应的失败提示信息，｝

权限说明：

所有账号只能在自己账号名下创建报警。

2更新报警

URL例：

请求地址：

:8089/DML/ALERT

修改url：

:8089/DML/ALERT?userName=***&password=***&PUT=roleJd,alertname&typeld=l&alert_id=

11313

请求参数说明:

参数名类型为空描述

userNameString否用户名

passwordString否密码

PUTString否要更新的字段序列，以逗号分隔

PUT对应修改列String否PUT中出现的所有字段，在url中必须给以

“&列=值”的方式出对应值

typeldNumber否取值1

alert_idNumber否要修改的报警id

PUT参数说明：

同创建报警字段相同

响应参数说明：

成功：｛/alert_id/:12345｝

失败：terror?对应的失败提示信息，｝

权限说明：

所有账号只能修改自己账号下创建的报警。

3删除报警

URL例：

请求地址：

:8089/DML/ALERT

删除url：

:8089/DML/ALERT?userName=***&password=***&DELETE=ALERT&typeld=l&alert_id=11313

请求参数说明:

参数名类型为空描述

userNameString否用户名

passwordString否密码

alertjdNumber否要删除的报警id

typeldNumber否取值1

响应参数说明:

成功：{}

失败：（errorT对应的失败提示信息。

权限说明：

所有账号均只能删除自己账号名下的报警

4查询报警

URL例：

请求地址：

:8089/DML/ALERT

查询url：

:8089/DML/ALERT?userName=***t&password=***&GET=alert_id/alertname&typeld=l&monito

r_fun=l

请求参数说明:

参数名类型为空描述

userNameString否用户名

passwordString否密码

GETString否查询的字段名称，字段至少写一列，多列

用逗号隔开

monitor_funNumber可任务监测类型

startString可查询报警起始时间，格式：'yyyy-MM/d

hh24:mi:ss'

endString可查询报警结束时间，格式：'yyyy・MM<ld

hh24:mi:ss'

alertjdNumber可查询报警的id

typeldNumber否值为1、2、3

注意：

typeld取值1,2,3,对应下列情况：

1获取本用户所有报警配置

2url中要有monitor_fun参数

3url中耍有start,end参数

响应参数说明：

成功：json格式返回GET对应报警配置列表

失败：〈error?对应的失败提示信息？

权限说明：

主账号：可查询主账号创建的报警，以及其名下子账号创建的所有报警

子账号：

a.没有读取权限：只能查询子账号自己创建的报警

b.有读取父账号权限：可查询子账号自己创建的报警，以及其父账号创建的报警

c.有所有读取权限：可查询子账号自己创建的报警、父账号的报警，以及父账号其它子账号

下的报警

d.所有一级子账号，都可查询其下二级账号创建的报警

5查询报警日志列表

URL例：

请求地址：

:8089/DML/ALERT_LOG

查询url：

:8089/DML/ALERT_LOG?userName=***&password=***&typeld=2&GET=ALERT.alert_type,$fileP

ath&start=2015-12-1813:41:00&end=2015-12-1815:41:00

请求参数说明:

参数名类型为空描述

userNameString否用户名

passwordString否密码

GETString否查询的字段名称，其中$filePath为报警详情

对应的地址，字段至少写一列，多列用逗号

隔开

startString可查询报警日志的起始时间

endString可查询报警日志的结束时间

alertlogjdNumber可报警log日志的id

typeldNumber否值为1或2

注：

typeld取值1,2,对应下列情况：

1llrl中必须有alertlogjd参数

2Uri中必须有alertjd,start,end参数

GET参数列说明:

参数名类型为空描述

LOG.alertJdNumber可报警id

ALERT.alert_tyPeNumber否报警类型，对应取值来源：5查询日志列表

中的alert_type

LOG.roleJdNumber可任务ID

LOG.monitor_funNumber可监测类型：1网络环境，2浏览/事务，4下

教，5流媒体，6元素组，7私有协议99-移

动单元素，98移动私有协议，97移动网络，

96移动全元素

LOG.alertJevelNumber可报警级别：0•普通报警；1•严重报警

LOG.indateDate可触发报警时间

LOG.alertlogjdNumber可报警日志id

LOG.smssend_statusNumber可SMS发送状态：1-已经发送；0-未发送

LOG.mailsend_statusNumber可MAIL发送状态：1--已经发送；0--未发送

LOG.alert_typeNumber可报警方式,0・・MAIL报警;1-短信报警;2-ira