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

<接口地址>: /alertapi/messages/info

<请求方式>:GET

<请求类型>:URL参数

<响应类型>:JSON

<请求参数>:

参数名称

是否必须

参数类型

默认值

示例

备注

token

string



请求token(在headers里)

id

int



告警消息id

<请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa"  https://v6-api.jiankongbao.com/alertapi/messages/info?id=17093084

<响应参数>:

名称

类型

是否必须

默认值

备注

其他信息

 th_id

Int

必须


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

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

 task_sort

Int

必须


任务性质

备注: 任务性质

 user_id

Int

必须


用户ID

备注: 用户ID

 data_time

timestamp

必须


检查时间

备注: 检查时间

 task_id

Int

必须


任务ID

备注: 任务ID

 trigger_status

Int

必须


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

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

 data_time_str

string

必须


检查时间(Y-m-d H:i:s格式)

备注: 检查时间(Y-m-d H:i:s格式)

 msg_content

String

必须


消息内容

备注: 消息内容

 trigger_type

Int

必须


消息类型 1:故障消息 2:自定义告警线消息 6:系统通知消息

备注: 消息类型 1:故障消息 2:自定义告警线消息 6:系统通知消息

 id

int

必须


监测点id

备注: 监测点id

 msg_time

Timestamp

必须


消息产生时间

备注: 消息产生时间

 task_summary

String

必须


任务URL或域名 

备注: 任务URL或域名 

 task_type

String

必须


任务类型

备注: 任务类型

 alert_time

integer

必须


消息发送时间(未发送时为-1

备注: 消息发送时间(未发送时为-1

 msg_time_str

string

必须


消息产生时间(Y-m-d H:i:s格式)

备注: 消息产生时间(Y-m-d H:i:s格式)

 task_name

String

必须


任务名称

备注: 任务名称

 alert_time_str

string

必须


消息发送时间(Y-m-d H:i:s格式)

备注: 消息发送时间(Y-m-d H:i:s格式)

 monitors

Array

必须


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

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

 name

String

必须


监测点名称

备注: 监测点名称

 msg_id

string

必须


消息id

备注: 消息id

 partition_flag 

string

必须


标识网站监控任务是否内网任务,Intranet内网,External外网

备注: 标识网站监控任务是否内网任务,Intranet内网,External外网

 account_id

integer

必须


企业账号id

备注: 企业账号id

 alertd_ids

string []

必须


发送记录id

备注: 发送记录id

item 类型: string

<响应示例>:

 {
    "task_name": "httptest,
    "task_type": "http",
    "task_summary": "www.baidu.com",
    "plugin_task_relation_id": null,
    "partition_flag": "External",
    "msg_id": "62e25ed40fd97",
    "user_id": 401327,
    "account_id": 131119,
    "task_id": 70549851,
    "task_sort": 0,
    "msg_time": 1659002580,
    "msg_time_str": "2022-07-28 18:03:00",
    "alert_time": -1,
    "alert_time_str": "",
    "data_time": 1659002572,
    "data_time_str": "2022-07-28 18:02:52",
    "trigger_type": 2,
    "trigger_status": 1,
    "msg_content": "陕西西安电信,上海市电信等211个监测点 当前响应时间大于12ms",
    "th_id": 67528549,
  "alert_ids": [123,456,789],
  "monitors": [
   {
            "id": 1,
            "name": "陕西西安电信"
        },
        {
            "id": 2,
            "name": "辽宁大连联通"
        }
    ......
  ]
}