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

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


<请求方式>:POST


<请求类型>:JSON


<响应类型>:JSON


<请求参数>:

指标名称

是否必须

数据类型

默认值

描述

task_name

string


任务名,模糊匹配

task_status

int


任务是否开启1,开启;3,暂停

trigger_status

int


告警线状态[0,1,2],0故障,1正常,2提醒

task_type

string


任务类型,可选项为'http','ping','ftp','tcp','udp','dns','traceroute'

task_type_arr

array


任务类型,为数组,可一次查询多个任务类型,可选项为'http','ping','ftp','tcp','udp','dns','traceroute'

task_type_arr与task_type同时存在时,采用task_type

page_size

int

20

每页多少条,可选项为[10,20,30,50,100]

current_page

int

1

当前页


<请求示例>:

{"task_name":"http","page_size":10,"current_page":1}


<响应数据>:

参数名称

数据类型

描述

pagination

json object

分页数据

total_records

int

总记录数

total_pages

int

总页数

current_page

int

当前页

page_size

int

分页数量

data

array

数据列表

task_id

String

任务ID

task_name

String

任务名称

task_summary

String

URL或域名

task_type

String

任务类型

task_create_time

String

任务创建时间

frequency

String

监控频率

task_status

String

任务状态

group_id

String

监测点分组id

last_resp_result

Int

检测结果。1成功,其它 失败

threshold_result

Int

1:未触发自定义告警线 

2:已触发自定义告警线

last_resp_status

String

返回的状态。

last_resp_time

String

响应时间。

last_check_time

String

最后一次检测数据返回的时间戳。该值只做参考,不作为准确依据。


<响应示例>:

{
    "pagination": {
        "total_records": 6,
        "total_pages": 1,
        "current_page": 1,
        "page_size": 10
    },
    "data": [
        {
            "task_id": "6923135",
            "task_name": "http_header_test3",
            "task_summary": "http://www.baidu.com",
            "task_type": "http",
            "frequency": "2",
            "group_id": "0",
            "task_create_time": "1515751581",
            "task_status": "1",
            "last_resp_result": 1,
            "threshold_result": 1,
            "last_resp_status": "-",
            "last_resp_time": "0.000000",
            "last_check_time": "-"
        },
        {
            "task_id": "6923125",
            "task_name": "http_app",
            "task_summary": "http://www.abcdtom123.com",
            "task_type": "http",
            "frequency": "2",
            "group_id": "0",
            "task_create_time": "1515468420",
            "task_status": "1",
            "last_resp_result": 0,
            "threshold_result": 2,
            "last_resp_status": "DNS无法解析",
            "last_resp_time": 0,
            "last_check_time": "1515477857"
        },
        {
            "task_id": "6922972",
            "task_name": "http_url_test_171129",
            "task_summary": "https://uapi.chiq-cloud.com/v2/user/isExisted",
            "task_type": "http",
            "frequency": "2",
            "group_id": "0",
            "task_create_time": "1511926813",
            "task_status": "3",
            "last_resp_result": 1,
            "threshold_result": 1,
            "last_resp_status": "-",
            "last_resp_time": "0.000000",
            "last_check_time": "-"
        }
    ]
}