[关闭]
@rzzx 2017-02-13T08:24:58.000000Z 字数 5361 阅读 607

掌上听云客户端NetWork API接口-警报->数据展示

NetWork

文档中主机名需要参考以下配置：

内网：http://192.168.5.197:8082/rpc
外网：未定

1. 步骤1：获取所有警报（network警报）

URL

/alarmLog.do

示例URL

http://192.168.5.197:8082/rpc/alarmLog.do?authkey=JraUZFype4&curPage=1&pageSize=50&timeFrom=2016-11-21 00:00&timeTo=2016-11-21 23:59

备注：这里返回的时间单位为毫秒，考虑服务器性能，转换由客户端来进行

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
curPage true string 第几页,从1开始,默认为1
pageSize true string 每页是多少条,默认为100
timeFrom true string 开始时间(格式为:yyyy-MM-dd HH:mm 下同)
timeTo true string 结束时间
taskId true string 任务id， 不传表示全部taskid
locate false String 地区

响应数据

  1. /*成功响应*/
  2. {
  3.     "status":200,
  4.     "data":{
  5.         "sustainAlarm":[ //持续中警报
  6.             {
  7.                 "alarm_id":11281, 
  8.                 "name":"任务列表测试-性能警报", //警报组名称
  9.                 "taskName":"任务列表测试", //任务名
  10.                 "itemseq":1,
  11.                 "hasRead":1, //是否已读未读，1为已读，0为未读
  12.                 "starttime":1479452497000 //开始时间
  13.             },
  14.             ...
  15.             ],
  16.         "clearAlarm":[ //已解除警报
  17.            {
  18.                 "alarm_id":11281, 
  19.                 "name":"任务列表测试-性能警报", //警报组名称
  20.                 "taskName":"任务列表测试", //任务名
  21.                 "itemseq":1,
  22.                 "hasRead":0, //是否已读未读，1为已读，0为未读
  23.                 "starttime":1479452497000 //开始时间
  24.             },
  25.             ...
  26.             ]
  27.     }
  28. }
  29. /*错误响应*/
  30. 没有数据
  31. /*错误响应*/
  32. {"status":503}
  33. /*错误响应*/
  34. {"status":-2} //authkey失效
  35. /*错误响应*/
  36. {"status":500,"message":"system error."}

1.1. 标记为单个已读

URL

/alarmLog.do

示例URL

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=read&authkey=JraUZFype4&alarmid=9292&itemseq=1

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
formAction true string 设置固定值为read
alarmid true string 步骤1获取的alarm_id
itemseq true string 步骤1获取的itemseq
locate false String 地区

响应数据

  1. /*成功响应*/
  2. {
  3.     "status":200
  4. }
  5. /*错误响应*/
  6. 没有数据
  7. /*错误响应*/
  8. {"status":503}
  9. /*错误响应*/
  10. {"status":-2} //authkey失效
  11. /*错误响应*/
  12. {"status":500,"message":"system error."}

1.2. 标记为全部已读

URL

/alarmLog.do

示例URL

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=readAll&authkey=JraUZFype4&taskId=&timeFrom=2016-11-21 00:00&timeTo=2016-11-21 23:59

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
formAction true string 设置固定值为readAll
timeFrom true string 开始时间(格式为:yyyy-MM-dd HH:mm 下同)
timeTo true string 结束时间
taskId true string 任务id， 不传表示全部taskid
locate false String 地区

响应数据

  1. /*成功响应*/
  2. {
  3.     "status":200,
  4.     "data":{
  5.         "sustainAlarm":[ //持续中警报
  6.             {
  7.                 "alarm_id":11281, 
  8.                 "name":"任务列表测试-性能警报", //警报组名称
  9.                 "taskName":"任务列表测试", //任务名
  10.                 "itemseq":1,
  11.                 "starttime":1479452497000 //开始时间
  12.             },
  13.             ...
  14.             ],
  15.         "clearAlarm":[ //已解除警报
  16.            {
  17.                 "alarm_id":11281, 
  18.                 "name":"任务列表测试-性能警报", //警报组名称
  19.                 "taskName":"任务列表测试", //任务名
  20.                 "itemseq":1,
  21.                 "starttime":1479452497000 //开始时间
  22.             },
  23.             ...
  24.             ]
  25.     }
  26. }
  27. /*错误响应*/
  28. 没有数据
  29. /*错误响应*/
  30. {"status":503}
  31. /*错误响应*/
  32. {"status":-2} //authkey失效
  33. /*错误响应*/
  34. {"status":500,"message":"system error."}

1.3 获取持续未读总数（network警报）

URL

/alarmLog.do

示例URL

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=count&authkey=JraUZFype4&curPage=1&pageSize=50&timeFrom=2016-11-21 00:00&timeTo=2016-11-21 23:59

备注：这里返回的时间单位为毫秒，考虑服务器性能，转换由客户端来进行

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
formAction true string 设置固定值为count
curPage true string 第几页,从1开始,默认为1
pageSize true string 每页是多少条,默认为100
timeFrom true string 开始时间(格式为:yyyy-MM-dd HH:mm 下同)
timeTo true string 结束时间
taskId true string 任务id， 不传表示全部taskid
locate false String 地区

响应数据

  1. /*成功响应*/
  2. {
  3.     "status":200,
  4.     "data":1
  5. }
  6. /*错误响应*/
  7. 没有数据
  8. /*错误响应*/
  9. {"status":503}
  10. /*错误响应*/
  11. {"status":-2} //authkey失效
  12. /*错误响应*/
  13. {"status":500,"message":"system error."}

2. 步骤2： 获取警报详情根据alarmid和itemseq（警报详情）

URL

/alarmLog.do

性能警报示例URL（之所以分开只是为了演示效果）

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=viewCyc&authkey=JraUZFype4&alarmid=9292&itemseq=1&curPage=1&pageSize=10

错误警报示例URL（之所以分开只是为了演示效果）

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=viewCyc&authkey=JraUZFype4&alarmid=9593&itemseq=1&curPage=1&pageSize=10

备注：这里返回的时间单位为毫秒，考虑服务器性能，转换由客户端来进行

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
formAction true string 设置固定值为viewCyc
alarmid true string 步骤1获取的alarm_id
itemseq true string 步骤1获取的itemseq
curPage true string 第几页,从1开始,默认为1
pageSize true string 每页是多少条,默认为100
locate false String 地区

响应数据

  1. /*成功响应*/性能警报
  2. {
  3.     "status":200,
  4.     "data":{
  5.         "timeList":[ //时间列表
  6.             {
  7.                 "id":154261,
  8.                 "name":"正常", //状态
  9.                 "ctime":1478087744000, //开始时间
  10.                 "aval_percent":"100.0", //可用性
  11.                 "perf":"10秒",//触发的阈值
  12.                 "canNext":true //是否可以点击下一步(相似与网站的查看按钮)
  13.             },
  14.             ...
  15.             ],
  16.         "reason":{  //警报原因
  17.             "reason1":"总下载时间超过10.0秒",
  18.             "baseName":"总下载时间",
  19.             "reason2":"可用性低于80%",
  20.             "condition":"或",
  21.             "groupBy":"城市", //可选的有：无、城市、运营商、主机、城市运营商、省份、省份运营商、元素域名
  22.             "gName":"北京市、天津市", //以、进行区分
  23.             "alarm_log":1//1代表是性能超过了阈值，2是可用性超过了阈值，3是性能及可用性超过了阈值
  24.         }，
  25.         "isPerf":"true" //是否是性能警报
  26.     }
  27. }
  29. /*成功响应*/错误警报
  30. {
  31.     "status":200,
  32.     "data":{
  33.         "timeList":[ //时间列表
  34.             {
  35.                 "id":154480,
  36.                 "name":"正常", //状态
  37.                 "ctime":1475132242000, //开始时间
  38.                 "datapoint_error":1, //错误数量
  39.                 "datapoint_total":2, //监测点数
  40.                 "canNext":true, //是否可以点击下一步(相似与网站的查看按钮)
  41.                 "errorPercent":50 //错误占比，显示直接+%即可
  42.             },
  43.             {
  44.                 "name":"正常",
  45.                 "ctime":1475132122000,
  46.                 "datapoint_error":1,
  47.                 "datapoint_total":2,
  48.                 "canNext":true,
  49.                 "errorPercent":50
  50.             }
  51.         ],
  52.         "reason":{ //警报原因
  53.             "reason":"错误监测点数或百分比1",
  54.             "errorTypes":"任务超时(页面)"
  55.         },
  56.          "isPerf":"false" //是否是性能警报
  57.     }
  58. }
  59. /*错误响应*/
  60. 没有数据
  61. /*错误响应*/
  62. {"status":503}
  63. /*错误响应*/
  64. {"status":-2} //authkey失效
  65. /*错误响应*/
  66. {"status":500,"message":"system error."}

3. 步骤3： 获取警报监测数据根据id

URL

/alarmLog.do

http://192.168.5.197:8082/rpc/alarmLog.do?formAction=view&authkey=JraUZFype4&id=161349

备注：这里返回的时间单位为毫秒，考虑服务器性能，转换由客户端来进行

请求参数

参数 必选 类型 说明
authkey true string 由authkey接口获取
formAction true string 设置固定值为view
id true string 步骤2获取的id
locate false String 地区

响应数据

  1. /*成功响应*/
  2. {
  3.     "status":200,
  4.     "data":[{
  5.         "time":1478086390000, //监测时间
  6.         "probIp":"192.168.5.133", //监测点IP
  7.         "cityName":"北京市", //监测城市
  8.         "ispName":"中国电信", //监测运营商
  9.         "destIp":"192.168.5.133", //主机IP
  10.         "destCityName":null, //主机城市
  11.         "destIspName":null, //主机运营商
  12.         "errorDetail":null, //错误描述
  13.         "downloadSpeedAvg":"24.4 KB/s",  //平均下载速度（KB/S）
  14.         "baseVal":"3.606 秒",
  15.         //这里的basVal就是指标的数值，然后指标名（例如：总下载时间）在上一级获取，然后需要判断其是否显示
  16.         "isAlarm":true//监测点是否是指标阈值触发的
  17.     },
  18.     ...
  19.     ]
  20. }
  22. /*错误响应*/
  23. 没有数据
  24. /*错误响应*/
  25. {"status":503}
  26. /*错误响应*/
  27. {"status":-2} //authkey失效
  28. /*错误响应*/
  29. {"status":500,"message":"system error."}
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注