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

<接口地址>:/userapi/accounts/package


<请求方式>:GET


<请求类型>:URL参数


<响应类型>:JSON


<请求参数>:

参数名称

是否必须

类型

默认值

描述






<请求示例>:

curl -H "token:a3af84f7c1d0d935024ba58b5da78aaa"  https://v6-api.jiankongbao.com
/userapi/accounts/package


<响应数据>:

参数名称

数据类型

描述

package_name

String

套餐名称

expired_date

Int

套餐到期日期(空表示无到期日期)

site_monitors_type

Int

监测点类型

1:所有   2:指定监测点中选择  3:国内   4:国外

designated_monitors

Array

指定的监测点(只有当site_monitor_type为2时才会有)

site_monitors_num

Int

可使用的监测点个数

sms_quota_month

Int

包月短信配额

site_task_num

Int

网站监控任务配额数

site_task_frequency

Int

网站监控任务可使用的最快监控频率

server_task_num

Int

服务器监控任务配额数

server_task_frequency

Int

服务器监控任务可使用的最快监控频率

service_task_num

Int

服务性能监控任务配额数

service_task_frequency

Int

服务性能监控任务可使用的最快监控频率

site_analysis_num

Int

网页性能监控任务配额

site_analysis_frequency

Int

网页性能监控任务可使用最快监控频率

api_task_num

Int

Api监控任务配额

api_task_frequency

Int

Api监控任务可使用的最快监控频率

voice_quota

Int

语音告警配额

custom_task_num

Int

自定义监控任务配额

ip_safety

Int

IP扫描任务配额

unit_task_num

Int

统一监控任务配额(统一配额套餐专有)

big_file

Int

大文件监控

:未开启    1:开启

big_file_num

Int

大文件监控任务配额

safe_check

Int

安全漏洞检测

0: 未开启   1:开启

safe_check_num

Int

安全漏洞检测任务配额

synthetic

Int

用户体验监控

0: 未开启   1:开启

synthetic_monitor_type

Int

用户体验监控使用的监测点类型

1:国内   2:国外  3:全部

synthetic_frequency

Int

用户体验监控任务最快允许的频率(单位:分钟)

synthetic_task_quota_status

int

用户体验平台是否开启任务配额

1:开启 0:不开启

synthetic_task_quota_max

int

用户体验平台任务配额数

all_snapshot

Int

开启全量快照1:开启 0:不开启

all_snapshot_num

int

全量快照配额

task_mtr

int

开启MTR1:开启 0:不开启

task_mtr_num

int

MTR配额

site_report_v2

int

网站报表v2 1: 0


<响应示例>:


{
    "package_name": "企业套餐",
    "expired_date": 1637463642,
    "sms_quota_month": 10000,
    "site_task_num": 10000,
    "site_task_frequency": 2,
    "site_monitors_num": 212,
    "site_monitors_type": 1,
    "server_task_num": 100,
    "server_task_frequency": 2,
    "service_task_num": 100,
    "service_task_frequency": 2,
    "site_analysis_num": 10,
    "site_analysis_frequency": 5,
    "api_task_num": 500,
    "api_task_frequency": 5,
    "voice_quota": 1000,
    "custom_task_num": 20,
    "big_file": 1,
    "big_file_num": 3,
    "safe_check": 0,
    "synthetic": 1,
    "synthetic_monitor_type": 3,
    "synthetic_frequency": 5,
    "synthetic_task_quota_status": 1,
    "synthetic_task_quota_max": 2000,
    "all_snapshot": 1,
    "all_snapshot_num": 100,
    "task_mtr": 1,
    "task_mtr_num": 50,
    "site_report_v2": 1
}