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

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

<请求方式>:POST          

<数据类型>:JSON

<响应类型>:JSON

<请求参数>:

参数名称

是否必须

类型

默认值

描述

start_time

Datetime

当天凌晨时间

查询起始时间(必须与end_time同时设置才生效),如:2019-10-24 00:00:00

end_time

Datetime

当前时间

查询结束时间(必须与start_time同时设置才生效)

current_page

Int

1

页码

page_size

Int

10

每页数量

task_ids

Array

当前用户所有可见任务

需要查询的任务id

<请求示例>:

curl –X POST –H ‘token:*******’ –d ‘{"start_time":"2019-10-23 00:00:00","end_time":"2019-09-24 00:00:00","current_page":1, "page_size":20,"task_ids":[123,456]}’ https://*******.com/siteapi/fault/tasks

<响应数据>:

参数名称

数据类型

描述

pagination

object

分页信息

total_records

int

记录总条数

total_pages

int

总页数

current_page

int

当前页码

page_size

int

每页条数

data

array

响应数据

data.time

string

故障所属日期

data.data.fault_id

String

故障id

data.data. task_id

Int

任务id

data.data. fault_snapshot

String

故障原因

data.data. fault_snapshot_desc

string

故障原因描述信息

data.data. start_time

String

故障起始时间

data.data. end_time

String

故障结束时间,若为“0”则故障仍未结束

data.data. task_name

string

任务名

data.data. task_type

string

任务类型

data.data. diff_time_str

string

故障时长

data.data. start_msg_id

String

故障开始时产生的消息id,若为“0”则表示未产生消息

data.data. end_msg_id

String

故障结束时产生的消息id,若为“0”则表示未产生消息

data.data. account_id

int

任务所属账号id

data.data. user_id

int

任务所属用户id

<响应示例>:

{
  "data": [
    {
      "time": "2019-10-24",
      "data": [
        {
          "fault_id": "255442",
          "start_time": "2019-10-24 00:31:28",
          "start_msg_id": "16975283",
          "end_time": "2019-10-24 00:41:31",
          "end_msg_id": "16975304",
          "diff_time_str": "10分3秒",
          "fault_snapshot": "403 Forbidden",
          "fault_snapshot_desc": "403 Forbidden",
          "task_id": 6925455,
          "task_name": "tom-v6-url_01",
          "task_type": "http",
          "account_id": 391,
          "user_id": 2670
        }
      ]
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 10,
    "total_records": 1,
    "total_pages": 1
  }
}