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

<接口地址>:/siteapi/message/list


<请求方式>:GET


<请求类型>:URL参数


<响应类型>:JSON


<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_id

Int


任务id

start_time

date

当天最开始的时间,如:2017-05-27 00:00:00

开始时间 (与end_time必须同时设置,不填则为默认值)

end_time

date

当前时间,如:2017-05-27   15:15:40

结束时间(与start_time必须同时设置。不填则为默认值)

trigger_type

Int

消息类型

消息类型  1:故障消息  2:自定义告警线消息

trigger_status

Int

消息状态

消息状态  0:恢复消息   1:触发消息

current_page

Int

1

当前页数

page_size

int

20

每页记录数


<请求示例>:

/siteapi/message/list?start_time=2016-04-01 00:00:00&end_time=2017-04-20 00:00:00


<响应数据>:

参数名称

数据类型

描述

pagination

object

分页信息

  total_records

int

记录总条数

  total_pages

int

总页数

  current_page

int

当前页码

  page_size

int

每页条数

data

array

json数组

 msg_id

Int

消息ID

 user_id

Int

用户ID

 task_id

Int

任务ID

 task_type

String

任务类型

 task_name

String

任务名称

 msg_time

string

消息产生时间

alert_time

string

消息发送时间(未发送时为“0”)

 data_time

string

检查时间

 msg_content

String

消息内容

 task_summary

String

任务URL或域名

trigger_status

Int

消息状态  0:恢复消息   1:触发消息

trigger_type

Int

消息类型  1:故障消息  2:自定义告警线消息 

th_id

Int

告警线id(只有是自定义告警线消息时,该字段才有值,否则为0)

monitors

Array

触发告警线的监测点(只有自定义告警线消息才有该返回项)

id

int

监测点id

name

String

监测点名称

en_name

String

监测点英文名

account_id

Int

账号id

alert_status

Int

告警状态


<响应示例>:

{
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1,
    "page_size": 20
  },
  "data": [
    {
      "msg_id": 8298923,
      "msg_time": "1482399932",
      "task_id": 6915863,
      "trigger_status": 1,
      "trigger_type": 2,
      "th_id": 111487,
      "msg_content": "上海市电信,广东深圳电信,浙江绍兴电信,四川成都电信,湖南长沙电信等6个监测点 当前响应时间大于1ms",
      "user_id": 25227972,
      "account_id": 391,
      "alert_time": "0",
      "alert_status": 0,
      "task_name": "test-ping-00001",
      "task_summary": "120.24.42.68",
      "task_type": "ping"
    }
  ]
}