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

<接口地址> /siteapi/agent/group/info

<请求方式> GET

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

<响应类型>:JSON

 

<请求参数>

参数名称

是否必须

参数类型

默认值

示例

备注

id

int


59

分组id,url重写传参

group_id

int


59

分组id,json格式传参








<请求示例>

curl -H "token:xxxxxxxxxxxxxx" http://dev.jkb.com:28080/siteapi/agent/info/1054?group_id=8

注意:请求参数id是url重写参数,group_id是json传参。两个参数必须要传一个。且group_id的优先级大于id


<响应参数>

名称

类型

是否必须

默认值

备注

其他信息

group_id

integer

必须


分组id

备注: 分组id

group_name

string

必须


分组名称

备注: 分组名称

user_id

integer

必须


用户id

备注: 用户id

create_time

string

必须


创建时间

备注: 创建时间

modify_time

string

必须


更新时间

备注: 更新时间

modify_user_id

integer

必须


更新用户id

备注: 更新用户id

agent_list

object []

必须


采集器列表

备注: 采集器列表

item 类型: object

agent_id

integer

必须


采集器id

备注: 采集器id

agent_name

string

必须


采集器名称

备注: 采集器名称

international_name

object

必须


国际化名称


ch

string

必须


中文名

备注: 中文名

en

string

必须


英文名

备注: 英文名

tw

string

必须


中文繁体

备注: 中文繁体

location_code

string

必须


地区id

备注: 地区id

isp_id

integer

必须


运营商id

备注: 运营商id

isp_name

string

必须


运营商名称

备注: 运营商名称

monitor_flag

string

必须


box:魔盒,public:公共监测点,agent:内网采集器

备注: box:魔盒,public:公共监测点,agent:内网采集器



























<响应示例>

{
    "group_id":59,
    "group_name":"jesseasad",
    "user_id":2670,
    "create_time":"2021-10-12 10:03:27",
    "modify_time":"2021-10-12 10:03:27",
    "modify_user_id":0,
    "agent_list":[
        {
            "agent_id":1000011,
            "agent_name":"sd",
            "international_name":{
                "ch":"sd",
                "en":"centos7-10.0.3.186",
                "tw":"centos7-10.0.3.186"
            },
            "location_code":"100440100",
            "isp_id":2,
            "isp_name":"\u8054\u901a"
        },
        ......
    ]
}