i2UP接口文档

# 系统管理

# 系统管理 - 更新配置

# URL

/sys/settings

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
cc_ip String 否 192.168.72.70
log_save_time String 否 30
page_size String 否 10
refresh_interval String 否 10
email_smtp_svr String 否 test
email_smtp_port String 否 25
email_smtp_ssl String 否 0
email_smtp_auth String 否 1
email_account String 否 test@info2soft.com
email_pwd String 否 123456
email_switch String 否 1
sms_switch String 否 1
sms_platform String 否 ali
sms_app_key String 否 AppKey
sms_secret_key String 否 SecretKey
sms_sign_name String 否 SignName
sms_template_code String 否 template
sms_server String 否
sms_username String 否
sms_password String 否
sms_domain_name String 否
sms_region_name String 否
sms_topic_urn String 否
notify_contact_biz Object 否
  phone String 否 11111111111
  email String 否 test@info2sost.com
notify_contact_chk Object 否
  phone String 否 11111111111
  email String 否 test@info2sost.com
  policy Object 否
    every String 否 month
    days String 否 5,6
notify_contact_status Object 否
  phone String 否 11111111111
  email String 否 test@info2sost.com
  policy Object 否
    every String 否 hour
    gap String 否 4
node_latest_ver String 否
node_upgrade_server String 否
node_upgrade_path String 否
node_online_upgrade String 否 0
mirr_skip String 否 0
passwd_expire String 否 30
passwd_length String 否 8
passwd_strong String 否 1
login_attempt String 否 13
login_lock String 否 10
notify_limit String 否 10
client_lang String 否 zh_cn
offline_mode Number 否 0
dtu_serial_device String 否
dtu_baud_rate String 否
email_title String 否
email_content String 否
email_from String 否
product_title Object 否
  title String 否
  copyright String 否
  favicon String 否
  copyright_logo String 否
  login_background String 否
  login_logo String 否
  home_logo String 否
  home_background String 否
  title_logo String 否
dist_cycle_alarm String 否 警报声循环
cmd_params Object 否 命令参数
  thread_num String 否 命令执行并发数
  begin_time String 否 开始时间
  end_time String 否 结束时间
  timeout String 否 命令超时时间

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否
ret Number 否 200
data Object 否
  message String 否 success update to latest version
  code Number 否 0

# 系统管理 - 命令列表

节点执行命令记录，包括：节点id、节点名称、命令类型、执行时间、执行结果、命令耗时

# URL

//distribution/sys/queue_list

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 1
page Number 否 1
user_uuids Array 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  info_list Array 否
    queue_uuid String 否 7F4D66E9-BD0B-ECF0-871E-91A59FEC22B3
    node_uuid String 否 7F4D66E9-BD0B-ECF0-871E-91A59FEC22B3
    node_name String 否 test
    exec_time String 否 2019-12-10 16:31:52
    done_time String 否 00:05:09
    queue_type Number 否 0 0 - 待执行

1 - 执行中 2 - 执行成功 3 - 执行失败 4 - 执行超时 |     status | Number | 否 | 3 | 0 - 升级 1 - 删除 4 - 组节点配置 5 - 单节点配置 6 - 同步文件网关组 7 - 同步流网关组 8 - 同步连接配置 |

# 系统管理 - 命令列表 - 删除

# URL

//distribution/sys/queue_list

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
uuids Array 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。

# 系统管理 - 一键升级 - 获取版本

获取版本号用于界面显示

# URL

//distribution/sys/upgrade_version

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  node_latest_ver String 否 4.0-19120918
  node_upgrade_server String 否 https://download.i2yun.com
  node_upgrade_path String 否 upgrade

# 系统管理 - 一键升级

升级操作

# URL

//distribution/sys/upgrade

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
uuids Array 否 空表示所有

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否
ret Number 否 200
data Object 否
  message String 否 success
  code Number 否 0

# 系统管理 - 告警统计

# URL

//distribution/sys/alarm_stat

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
user_uuids Array 否 获取所选用户的告警统计

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  info_list Object 否
    warn_num Number 否 23 未查看警告数
    error_num Number 否 33 未查看错误数
    offline_num Number 否 23 未查看离线数
    traffic_warn_num Number 否 10 未查看流量警告数

# 系统管理 - 告警日志

# URL

//distribution/sys/alarm_log

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
page Number 否
limit Number 否
log_level Number 否
user_uuids Array 否
where_args Array 否 目前支持readed:t or f

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否
ret Number 否 200
data Object 否
  code Number 否 0
  message String 否 Delete success
  total Number 否 告警日志总数
  info_list Array 否
    create_time String 否 2019-08-09 17:29:43 告警时间
    log_level Number 否 1 日志等级:

1 - 正常 2 - 警告 3 - 异常 4 - 离线 5 - 流量异常 |     log_type | String | 否 | 0 | 日志类型 保留字段 |     detail | String | 否 | 数据流分发:正常->离线; | 告警内容 |     uuid | String | 否 | @guid | 日志uuid |     readed | String | 否 | f | 响应标志：是否已读 f 未读 t 已读 |     node_name | String | 否 | | 节点名称 |     node_type | Number | 否 | | 节点类型 |

# 系统管理 - 告警日志 - 操作

# URL

//distribution/sys/alarm_log_operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
operate String 否 delete - 删除；read - 标记为已读
uuids Array 否 需要操作的uuid 注: 为空表示所有

# Response

名称 类型 必选 初始值 简介 Mock规则
msg String 否
ret Number 否 200
data Object 否
  message String 否 success
  code Number 否 0

# ------用户管理-------

# URL

//dash0

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则

# 用户管理(admin)-新增用户

# URL

/user

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
username String 否 test2 用户名
password String 否 11111111 密码
roles Array 否 ["3"] 角色类型
active Number 否 1 服务状态：正常、注销、服务到期
email String 否 11@info2soft.com Email地址
mobile String 否 12366666666 手机号
comment String 否 备注
full_name String 否 用户全称
property Number 否 用户性质

0：免费 1：移动普及版 2：移动全价 3：PC 普及版 4：PC 半价 5：PC全价 | type | Number | 否 | | 用户类型 0： 个人， 1： 机构 | begin_date | String | 否 | | 生效开始日期 | end_date | String | 否 | | 生效结束日期 | product_name | String | 否 | | 产品名称 | sys_name | String | 否 | | 转发系统名称 | lab_name | String | 否 | | 转发机房名称 | contact | String | 否 | | 联系人 | address | String | 否 | | 通讯地址 |

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  uuid String 否 773B582B-E6E9-7236-3465-EC4E3B889A8A
  keys Object 否
    access_key String 否 wUVIkvDcuRE75dJnj2LQANKpCMbTlF6i
    secret_key String 否 SLhGo6X5swUBCv0Z3HOyNAY9nmM1QupF42RVbceE
    user_uuid String 否 773B582B-E6E9-7236-3465-EC4E3B889A8A

# 用户管理(admin)-修改用户信息

# URL

/user/:id([0-9]+)

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
username String 否 test2
password String 否 11111111
roles Array 否 ["3"]
active String 否 1
email String 否 11@info2soft.com
mobile String 否 12366666666
comment String 否
full_name String 否
property Number 否 1
type Number 否 1
begin_date String 否 1
end_date String 否 1
product_name String 否
sys_name String 否
lab_name String 否
contact String 否
address String 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  uuid String 否 773B582B-E6E9-7236-3465-EC4E3B889A8A
  keys Object 否
    access_key String 否 wUVIkvDcuRE75dJnj2LQANKpCMbTlF6i
    secret_key String 否 SLhGo6X5swUBCv0Z3HOyNAY9nmM1QupF42RVbceE
    user_uuid String 否 773B582B-E6E9-7236-3465-EC4E3B889A8A

# 用户管理(admin)-用户列表(admin)

# URL

/user

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 10
page Number 否 1
search_field String 否 username: 按用户名查询 property: 按用户性质查询
search_value String 否
begin_date String 否 按时间范围查询
end_date String 否 按时间范围查询

# Response

名称 类型 必选 初始值 简介 Mock规则

# 系统管理-获取配置

获取行情用户列表

# URL

/sys/settings

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  configs Object 否
    cc_uuid String 否 5C69B941-1959-D5A6-CFAB-7335DC7B6160
    cc_ip String 否 192.168.7.8
    refresh_token_period String 否 0
    refresh_interval String 否 10
    page_size String 否 10
    log_save_time String 否 30
    client_lang String 否 zh_cn
    passwd_expire String 否 15
    passwd_length String 否 8
    passwd_strong String 否 0
    login_attempt String 否 12
    login_lock String 否 20
    mirr_skip String 否 0
    node_online_upgrade String 否 1
    node_latest_ver String 否 d
    node_upgrade_server String 否 dd
    node_upgrade_path String 否 d
    dist_cycle_alarm String 否 1
    cmd_params Object 否
      thread_num String 否 10
      timeout String 否 15
      begin_time String 否
      end_time String 否
  users Array 否 8
    username String 否 test3
    user_uuid String 否 952C0C5A-4E09-70D3-AD80-D11614790302

# 用户管理 - 用户统计

用于显示每日用户和每月用户统计

# URL

/user/stat

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
start String 否 必传
end String 否 必传
type String 否 daily： 每日用户
monthly： 每月用户
limit Number 否
page Number 否

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  info_list Array 否
    date String 否 20191211 日期
    begin_num Number 否 33 当日/当月 开通用户数
    begin_toll_num Number 否 23 当日/当月 开通收费用户数
    begin_free_num Number 否 10 当日/当月 开通免费用户数
    end_num Number 否 10 当日/当月 注销用户数

# ------底层接口-------

# URL

/dash1

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则

# 同步网关

# URL

//distribution/sys/sync_gateway

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
user_name String 否
passwd String 否
node_uuid String 否
gw_type String 否 1:流
0:文件
data Array 否
  ip String 否
  port String 否
  desc String 否 描述
  node String 否 节点数量

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  failed_nodes String 否 dGVzdDEsdGVzdDIsdGVzdDM=
  not_exist_ips String 否 MTkyLjE2OC43LjcsMTkyLjE2OC43LjgsMTkyLjE2OC43Ljk=

# 同步账号

# URL

//distribution/sys/sync_account

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
user_name String 否
passwd String 否
node_uuid String 否
enable_file String 否 文件是否全部启用
enable_stream String 否 流是否全部启用
data Array 否
  code String 否 连接代码
  name String 否 连接名称
  pwd String 否 连接密码
  limit String 否 连接数
  privilege String 否
  type_name String 否 类别名称
  enable_file String 否 文件是否启用
  enable_stream String 否 流是否启用

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  failed_nodes String 否 dGVzdDEsdGVzdDIsdGVzdDM=

# 获取发送文件信息

# URL

//distribution/sys/send_files

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
user_name String 否 用户名
passwd String 否 密码
group_uuid String 否 组id
parent_addrs Array 否 上级地址
  ip String 否 ip
  port String 否 port，为空表示默认26870
version String 否 列表类别

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  send_files String 否 dGVzdDEsdGVzdDIsdGVzdDM=
  recv_files String 否 MTkyLjE2OC43LjcsMTkyLjE2OC43LjgsMTkyLjE2OC43Ljk=
  systime String 否
  group_uuid String 否 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
Last Updated: 5/13/2020, 3:56:32 AM