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

<接口地址>: /siteapi/tasks/{task_id}


<请求方式>:GET


<请求类型>:URL路径参数


<响应类型>:JSON


<请求参数>:

参数名称

是否必须

类型

默认值

描述

task_id

Int


任务id


<请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa"  https://v6-api.jiankongbao.com/siteapi/tasks/12

 

<响应数据>:

说明:响应的数据模型以文档中的响应数据和响应示例为准,接口实际多出的响应字段为已废弃或预留暂未使用字段


<公共响应数据> :

参数名称

数据类型

描述

task_id

string

任务编号

task_name

string

任务名称

task_summary

string

任务摘要

task_user_id

int

任务创建用户编号

task_type

string

任务类型

task_create_time

String

任务创建时间,时间戳

task_status

String

任务状态,[1-开启 3-暂停]

frequency

String

监控频率

alert_freq

String

告警频率[0-无,其他数字时为监控频率的倍数]

is_remind

String

告警通知连续提醒

monitor_history

String

记录节点故障快照[0-关闭,1-开启]

retry

String

重试次数

 network_protocol String

 任务使用的网络协议。

  • 4: 使用IPV4协议

  • 6: 使用IPV6协议

group_id

String

监测点分组id

task_permission

string

任务公开范围

organization

array

公开范围分组列表

user_ids

array

公开范围用户列表

account_id

String

帐号id

hasOverseasMonitor

Int

任务是否选择有海外监测点

 

具体类型的任务修改请参考: