文档首页
API docs by Redocly

爱快 OpenAPI - 系统 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

来源于 ikuai-doc/openapi_specs/system/。

为避免 Redoc 单页一次性加载全部 API 导致浏览器 heap 过高，部署版按分类拆分。

ALG应用层网关管理API

来源文件: system/system-alg.json

获取ALG配置

获取当前ALG应用层网关的配置信息，包括各协议的支持状态和自定义端口配置。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新ALG配置

全量更新ALG应用层网关配置。所有字段均为必填，即使未修改也必须携带原值。 端口约束：

  • 每种协议最多配置7个自定义端口
  • FTP、TFTP、SIP三种协议间的自定义端口不可重复
  • 默认端口（FTP:21、SIP:5060、TFTP:69）由系统自动追加，无需填入

    注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

ALG配置数据（全量更新，所有字段必填，未修改的字段须传原值）

support_ftp
required
integer
Default: 1
Enum: 0 1

FTP协议ALG开关（0关闭，1开启）

support_tftp
required
integer
Default: 1
Enum: 0 1

TFTP协议ALG开关（0关闭，1开启）

support_sip
required
integer
Default: 1
Enum: 0 1

SIP协议ALG开关（0关闭，1开启）

support_h323
required
integer
Default: 1
Enum: 0 1

H323协议ALG开关（0关闭，1开启）

ftp_ports
required
string
Default: ""

FTP自定义端口，逗号分隔，最多7个，与SIP/TFTP端口不可重复，不含默认端口21

sip_ports
required
string
Default: ""

SIP自定义端口，逗号分隔，最多7个，与FTP/TFTP端口不可重复，不含默认端口5060

tftp_ports
required
string
Default: ""

TFTP自定义端口，逗号分隔，最多7个，与FTP/SIP端口不可重复，不含默认端口69

Responses

Request samples

Content type
application/json
{
  • "support_ftp": 1,
  • "support_tftp": 1,
  • "support_sip": 1,
  • "support_h323": 1,
  • "ftp_ports": "2121",
  • "sip_ports": "",
  • "tftp_ports": ""
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

系统备份管理API

来源文件: system/system-backup.json

获取备份信息

查询备份文件列表及磁盘使用情况。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

手动备份配置

立即将当前系统配置打包为备份文件（.bak）并保存。无需请求体。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

删除备份文件

删除指定备份文件及其数据库记录。通过 query 参数 srcfile 指定要删除的备份文件，无需请求体。

Authorizations:
bearerAuth
query Parameters
srcfile
required
string
Example: srcfile=20240407120000.bak

要删除的备份文件名，格式为 YYYYMMDDHHmmss.bak

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

恢复备份

将系统配置恢复至指定备份文件。srcfile 需放在请求体中传入。操作成功后系统将自动重启（约 2 秒后）。

restore_type 说明：

  • 0（默认）：仅恢复配置，不切换固件版本
  • 1：同时恢复固件版本（需从云端下载对应固件，耗时较长）

sync_bind_cloud 说明：

  • 0（默认）：不同步云平台绑定信息
  • 1：同步导入云平台绑定信息，此时 cloud_comment 为必填

版本兼容限制：

  • 4.0 配置不可恢复到 3.x 设备
  • 4.0 设备不可恢复 3.x 配置
Authorizations:
bearerAuth
Request Body schema: application/json
required
srcfile
required
string

要恢复的备份文件名，格式为 YYYYMMDDHHmmss.bak

restore_type
integer
Default: 0
Enum: 0 1

恢复类型：0=仅恢复配置，1=同时恢复固件版本

sync_bind_cloud
integer
Default: 0
Enum: 0 1

是否同步导入云平台绑定信息：0=否，1=是（此时 cloud_comment 必填）

cloud_comment
string [ 1 .. 63 ] characters

云端设备备注名称，sync_bind_cloud=1 时必填，长度 1-63 字符，支持 @ - _ + . 等特殊字符（不支持冒号）

Responses

Request samples

Content type
application/json
Example
{
  • "srcfile": "20240407120000.bak",
  • "restore_type": 0,
  • "sync_bind_cloud": 0,
  • "cloud_comment": "branch-office-router"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

获取自动备份策略

查询当前自动备份策略配置。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

保存自动备份策略

更新自动备份策略配置。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

cycle_time 格式说明（依 strategy 而定）：

  • strategy=one（单次）：具体日期，格式 YYYY-MM-DD，如 2024-04-07
  • strategy=week（每天）：填 all
  • strategy=week（每周）：填星期组合串，如 135（周一三五），至少选 1 天
  • strategy=month（每月）：填月内执行日，范围 1-31，如 15
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
integer >= 1

当前备份策略记录ID

enabled
required
string
Enum: "yes" "no"

是否启用自动备份

strategy
required
string
Enum: "one" "week" "month"

备份周期类型：one=单次，week=每日/每周，month=每月

time
required
string^([01]\d|2[0-3]):[0-5]\d$

执行时间，格式 HH:mm

cycle_time
required
string

执行周期值，格式依 strategy 而定（见接口描述）

valid_days
required
integer [ 0 .. 365 ]

自动备份文件保留天数，0 表示不限期

Responses

Request samples

Content type
application/json
Example
{
  • "id": 1,
  • "enabled": "yes",
  • "strategy": "week",
  • "time": "08:00",
  • "cycle_time": "135",
  • "valid_days": 30
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

系统基础设置API

来源文件: system/system-basic.json

获取系统基础设置

获取当前系统的基础设置配置信息，包括主机名、语言、时区、 上网模式、NTP配置、链路模式等所有基础设置项。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新系统基础设置

更新系统的基础设置配置信息，包括主机名、语言、时区、 上网模式、NTP配置、链路模式等设置。 企业版功能设置在免费版上不生效。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

系统基础设置配置数据

hostname
required
string <= 21 characters

主机名（1-21个字符，允许中文、字母、数字、: @ - _ + .）

language
required
integer
Enum: 1 2

选择语言，1-中文，2-英文；企业版功能，免费版设置不生效

time_zone
required
integer [ -12 .. 14 ]

时区偏移量（UTC），如东八区为8

time_zone_full
required
string^[0-9]{4}$
Default: "0800"

国际时区全格式（例 0800），默认值 '0800'

switch_nat
required
integer
Enum: 0 1 2

上网模式，0=NONAT，1=对称NAT，2=全锥形NAT

switch_ntp
required
integer
Enum: 0 1

自动更新时间开关，0-关 1-开

switch_ntpd
required
integer
Enum: 0 1

ntpd 服务开关，0-关 1-开

switch_ntpserver
required
integer
Enum: 0 1

NTP 服务器开关，0-关 1-开

ntpserver_list
required
string <= 253 characters

自定义 NTP 服务器列表，最长253个字符，支持 IPv4/IPv6/域名

ntp_sync_cycle
required
integer [ 5 .. 240 ]

NTP 同步间隔（分钟）

link_mode
required
integer
Enum: 0 1 2

链路模式，0=主干模式，1=旁路模式，2=SDWAN 桥

lan_nat
required
integer
Enum: 0 1

路由模式(switch_nat=0)时是否启用 LAN 地址 NAT，0=关 1=开

backport
required
string

旁路模式上网接口

listenport
required
string

旁路模式监听接口

fast_nat
required
integer
Enum: 0 1 2

加速模式，0关闭，1开启软件模式，企业版功能，免费版设置不生效

Responses

Request samples

Content type
application/json
{
  • "hostname": "Router",
  • "language": 1,
  • "time_zone": 8,
  • "time_zone_full": "0800",
  • "switch_nat": 1,
  • "switch_ntp": 1,
  • "switch_ntpd": 0,
  • "switch_ntpserver": 0,
  • "ntpserver_list": "",
  • "ntp_sync_cycle": 60,
  • "link_mode": 0,
  • "lan_nat": 1,
  • "backport": "wan1",
  • "listenport": "lan1",
  • "fast_nat": 0
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

立即进行NTP同步

立即执行NTP时间同步，强制系统与NTP服务器进行时间校准。 请确保NTP服务已启用且网络连接正常。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success"
}

CPU频率管理API

来源文件: system/system-cpufreq.json

获取CPU实时频率

获取所有CPU核心的实时频率信息、使用率、中断统计等数据。 包含CPU ID、物理ID、核心ID、频率、使用率、软硬中断数等信息。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取CPU工作模式

获取CPU的工作模式配置信息，包括当前调频模式、睿频状态、 支持的模式列表等配置。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

配置CPU工作模式

全量更新CPU工作模式配置。所有字段均为必填，即使未修改也必须携带原值。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

全量更新，所有字段必填，未修改的字段须传原值

mode
required
string
Enum: "off" "conservative" "ondemand" "powersave" "performance" "schedutil"

CPU调频模式

turbo
required
integer
Enum: 0 1

CPU睿频开关（0关闭，1开启）

Responses

Request samples

Content type
application/json
{
  • "turbo": 1,
  • "mode": "performance"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}

系统磁盘信息API

来源文件: system/system-disks.json

获取系统磁盘信息

获取当前系统的磁盘列表，以及每块磁盘下的分区、文件系统和挂载信息。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

系统文件管理API

来源文件: system/system-files.json

获取文件列表

根据 path 查询文件列表。

常见用法：

  • path=/：获取系统中可用的文件存储根目录
  • path=/test-001：获取指定目录下的文件和子目录列表
Authorizations:
bearerAuth
query Parameters
path
required
string
Example: path=/

要查询的文件路径

Responses

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

内核参数配置API

来源文件: system/system-kernel-params.json

获取内核参数配置

获取当前内核网络参数配置，包括BBR、TCP/UDP/ICMP各超时时间。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新内核参数配置

全量更新内核网络参数配置。所有字段均为必填，即使未修改也必须携带原值。

Authorizations:
bearerAuth
Request Body schema: application/json
required

全量更新，所有字段必填，未修改的字段须传原值

bbr
required
integer
Enum: 0 1

BBR拥塞控制算法（0关闭，1开启）

syn_recv_timeout
required
integer [ 5 .. 60 ]

SYN_RECV状态超时时间（秒）

syn_send_timeout
required
integer [ 5 .. 60 ]

SYN_SEND状态超时时间（秒）

established_timeout
required
integer [ 600 .. 86400 ]

ESTABLISHED状态超时时间（秒）

fin_wait_timeout
required
integer [ 5 .. 60 ]

FIN_WAIT状态超时时间（秒）

last_ack_timeout
required
integer [ 5 .. 60 ]

LAST_ACK状态超时时间（秒）

close_wait_timeout
required
integer [ 5 .. 60 ]

CLOSE_WAIT状态超时时间（秒）

time_wait_timeout
required
integer [ 5 .. 60 ]

TIME_WAIT状态超时时间（秒）

close_timeout
required
integer [ 5 .. 60 ]

CLOSE状态超时时间（秒）

udp_timeout
required
integer [ 5 .. 60 ]

UDP数据包超时时间（秒）

udp_stream_timeout
required
integer [ 30 .. 1800 ]

UDP流超时时间（秒）

icmp_timeout
required
integer [ 5 .. 100 ]

ICMP数据包超时时间（秒）

Responses

Request samples

Content type
application/json
{
  • "bbr": 0,
  • "syn_recv_timeout": 5,
  • "syn_send_timeout": 5,
  • "established_timeout": 1800,
  • "fin_wait_timeout": 10,
  • "last_ack_timeout": 10,
  • "close_wait_timeout": 10,
  • "time_wait_timeout": 10,
  • "close_timeout": 5,
  • "udp_timeout": 10,
  • "udp_stream_timeout": 60,
  • "icmp_timeout": 10
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

系统重启计划管理API

来源文件: system/system-reboots.json

获取重启计划列表

获取当前配置的所有重启计划列表，支持分页功能。 包含计划状态、事件类型、周期策略、执行时间等信息。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=id

排序字段，支持id、time、strategy等字段

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

添加重启计划

添加新的重启计划，指定计划事件（重启/关机）、周期策略、 执行时间和备注信息。支持一次性、每周、每月三种周期类型。

Authorizations:
bearerAuth
Request Body schema: application/json
required

重启计划配置数据

enabled
required
string
Enum: "yes" "no"

状态，yes为启用，no为停用

event
required
string
Enum: "reboot" "poweroff"

计划事件，reboot为重启，poweroff为关机

strategy
required
string
Enum: "one" "day" "week" "month"

计划周期：

  • one: 一次性执行
  • day: 每天执行
  • week: 每周执行
  • month: 每月执行
cycle_time
required
string^([0-9]{4}-[0-9]{2}-[0-9]{2}|[1-7]|all|[1-9]|...

计划日期，根据strategy字段有不同的含义：

  • strategy=one: 日期格式 YYYY-MM-DD
  • strategy=week: 星期数字(1-7)或字符串"all"表示每天
  • strategy=month: 月份中的日期数字(1-31)
tagname
required
string <= 15 characters

标识名称（支持中文/数字/字母/下划线/连字符，不能以符号开头，1-15字符）

time
required
string^([0-1][0-9]|2[0-3]):[0-5][0-9]$

计划时间，格式为HH:MM

comment
string <= 64 characters

备注信息，最多64个字符，不支持特殊字符

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "event": "reboot",
  • "strategy": "week",
  • "cycle_time": "7",
  • "time": "00:00",
  • "comment": "每周日重启计划"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

获取指定重启计划

根据计划ID获取单个重启计划的详细信息。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

重启计划ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新重启计划

完全更新现有的重启计划配置。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

重启计划ID

Request Body schema: application/json
required

完整的重启计划配置数据

enabled
required
string
Enum: "yes" "no"

状态，yes为启用，no为停用

event
required
string
Enum: "reboot" "poweroff"

计划事件，reboot为重启，poweroff为关机

strategy
required
string
Enum: "one" "day" "week" "month"

计划周期：

  • one: 一次性执行
  • day: 每天执行
  • week: 每周执行
  • month: 每月执行
cycle_time
required
string^([0-9]{4}-[0-9]{2}-[0-9]{2}|[1-7]|all|[1-9]|...

计划日期，根据strategy字段有不同的含义：

  • strategy=one: 日期格式 YYYY-MM-DD
  • strategy=week: 星期数字(1-7)或字符串"all"表示每天
  • strategy=month: 月份中的日期数字(1-31)
tagname
required
string <= 15 characters

标识名称（支持中文/数字/字母/下划线/连字符，不能以符号开头，1-15字符）

time
required
string^([0-1][0-9]|2[0-3]):[0-5][0-9]$

计划时间，格式为HH:MM

comment
string <= 64 characters

备注信息，最多64个字符，不支持特殊字符

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "event": "reboot",
  • "strategy": "week",
  • "cycle_time": "7",
  • "tagname": "每周日重启",
  • "time": "00:00",
  • "comment": "test001"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

启用/停用重启计划

部分更新重启计划配置，主要用于启用/停用计划状态。 支持修改enabled字段来控制计划的执行状态。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

重启计划ID

Request Body schema: application/json
required

部分更新数据（如启用状态）

enabled
required
string
Enum: "yes" "no"

计划启用状态

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除重启计划

删除指定的重启计划。 删除后无法恢复，请谨慎操作。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

重启计划ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

远程访问配置API

来源文件: system/system-remote-access.json

获取远程访问配置

获取当前远程访问服务的配置信息，包括Telnet、SSH服务状态、 Web管理端口设置、外网访问权限、HTTPS强制跳转等配置。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新远程访问配置

更新远程访问服务的配置信息，包括Telnet和SSH服务的启用状态、 端口配置、Web管理端口设置、外网访问权限、HTTPS强制跳转等。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

远程访问配置数据

open_telnetd
required
integer
Default: 0
Enum: 0 1

开启telnetd服务，0为关闭，1为开启

open_wanweb
required
integer
Default: 0
Enum: 0 1 2 3

外网访问web管理权限，0为不允许访问，1为都允许，2为允许ipv4，3为允许ipv6

open_sshd
required
integer
Default: 0
Enum: 0 1

开启SSHD服务，0为关闭，1为开启

sshd_port
required
integer [ 0 .. 65535 ]
Default: 22

SSHD服务端口，0表示关闭。允许范围10-599和800-65535，排除1234-1241、12345、34567

sshd_passwd
required
string [ 6 .. 64 ] characters

SSHD登录密码

http_port
required
integer [ 0 .. 65535 ]
Default: 80

HTTP管理端口，0表示关闭HTTP。允许范围10-599和800-65535，排除1234-1241、12345、34567

https_port
required
integer [ 0 .. 65535 ]
Default: 443

HTTPS管理端口，0表示关闭HTTPS。允许范围10-599和800-65535，排除1234-1241、12345、34567

force_https
required
integer
Default: 0
Enum: 0 1

强制使用HTTPS访问，访问HTTP时强制跳转HTTPS，0为不强制，1为强制

Responses

Request samples

Content type
application/json
{
  • "open_telnetd": 0,
  • "open_wanweb": 1,
  • "open_sshd": 1,
  • "sshd_port": 22,
  • "sshd_passwd": "ikuai8.com",
  • "http_port": 80,
  • "https_port": 443,
  • "force_https": 0
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

系统固件升级API

来源文件: system/system-upgrade.json

版本检测

向云端发起版本检测请求，拉取最新版本信息并缓存到本地。无需请求体。

检测完成后，调用「获取版本信息」接口获取最新版本详情。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

获取版本信息

查询当前固件版本与云端最新版本信息，用于判断是否需要升级。

new_system_ver 为空或与 system_ver 相同时表示已是最新版本。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

立即升级

触发系统固件升级，从云端下载最新固件并安装。升级过程为后台异步执行。

请求体必须传入 type，且值固定为 system。

触发后请轮询「获取升级状态」接口跟踪进度。

Authorizations:
bearerAuth
Request Body schema: application/json
required

升级请求参数

type
required
string

升级类型，固定传 system

Value: "system"

Responses

Request samples

Content type
application/json
{
  • "type": "system"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

获取升级状态

查询当前固件升级任务的执行状态与进度。

status 状态码说明：

  • 0：无升级任务（空闲或升级成功完成）
  • 1：正在下载固件（status_msg 包含下载进度百分比）
  • 2：正在安装固件
  • -1：固件信息获取失败
  • -2：固件下载失败
  • -3：固件文件解析失败
  • -4：固件安装失败

轮询建议： 每 2 秒轮询一次，直到 status <= 0 为止。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

VRRP热备管理API

来源文件: system/system-vrrp.json

获取热备配置

获取当前VRRP热备的配置信息，包括启用状态、工作模式、 优先级、心跳接口、虚拟IP等配置。不支持filter和limit。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

设置热备配置

配置VRRP热备的各项参数，包括工作模式、优先级、心跳接口、 虚拟IP、配置同步等设置。支持主模式、备份模式、负载模式。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

VRRP热备配置数据

enabled
required
string
Enum: "yes" "no"

开启状态，yes为启用，no为停用

type
required
integer
Enum: 1 3

工作模式，1=主备模式，3=负载模式

prio
required
integer [ 0 .. 255 ]

优先级

method
integer
Default: 2
Enum: 0 1 2

探测方式，0=DNS+PING，1=DNS，2=PING

domain
string
Default: "www.baidu.com"

DNS探测域名

dns
string
Default: "114.114.114.114"

DNS服务地址

gateway
required
string <ipv4>

PING 探测的目标 IP 地址

interval
integer [ 1 .. 255 ]
Default: 3

心跳间隔（秒）

ifnames
required
string

外网接口探测列表

auto_sync
required
integer
Enum: 0 1

是否开启配置的自动同步（0=否，1=是），仅企业版支持

single_line
required
integer
Enum: 0 1

是否开启单线环境（0=否，1=是）

ignore_wanstatus
required
integer
Enum: 0 1

是否开启外网检测（0=否，1=是）

interfaces
required
string

传输链路接口列表

virtual_ips
required
string

传输链路对应接口的虚拟IP

ht_iface
required
string

心跳接口

remote_addr
required
string <ipv4>

对端的 IP 地址（心跳线）

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "type": 1,
  • "prio": 150,
  • "gateway": "8.8.8.8",
  • "ifnames": "wan1,wan2",
  • "auto_sync": 0,
  • "single_line": 0,
  • "ignore_wanstatus": 1,
  • "interfaces": "wan1,wan2",
  • "virtual_ips": "192.168.1.254,10.0.0.254",
  • "ht_iface": "eth0",
  • "remote_addr": "192.168.1.100"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}

开启热备配置

启动VRRP热备服务，使热备配置生效。 启动前请确保热备参数配置正确。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success"
}

关闭热备配置

停止VRRP热备服务，停止热备功能。 停止前请确认不会影响现有业务的高可用性。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success"
}

WEB登录账号与用户组管理API

来源文件: system/system-web-admin-accounts.json

获取WEB登录用户组列表

获取 WEB 管理后台登录用户组列表。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码，从 1 开始

limit
integer >= 1
Default: 50
Example: limit=50

每页返回记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

新增WEB登录用户组

新增一个 WEB 管理后台登录用户组。

用户组是账号权限的载体，建议先创建组，再创建账号。

Authorizations:
bearerAuth
Request Body schema: application/json
required

WEB 登录用户组创建数据

group_name
required
string

用户组名称

ip_addr
required
string

安全 IP 地址范围

perm_config
required
string

权限配置字符串，菜单 key 对应设备侧 menu.json

Responses

Request samples

Content type
application/json
{
  • "group_name": "readonly",
  • "ip_addr": "0.0.0.0/0",
  • "perm_config": "monitoring_center:r,network_configuration:r"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success",
  • "rowid": 3
}

获取单个WEB登录用户组详情

根据 ID 获取单个 WEB 登录用户组详情。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录用户组 ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

全量修改WEB登录用户组

全量修改指定 ID 的 WEB 登录用户组。

注意：

  • 用户组 id = 1 为超级管理员组
  • 该组除名称外，其它属性不应修改
Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录用户组 ID

Request Body schema: application/json
required

WEB 登录用户组更新数据

group_name
required
string

用户组名称

ip_addr
required
string

安全 IP 地址范围

perm_config
required
string

权限配置字符串，菜单 key 对应设备侧 menu.json

Responses

Request samples

Content type
application/json
{
  • "group_name": "readonly",
  • "ip_addr": "192.168.3.0/24",
  • "perm_config": "monitoring_center:r,network_configuration:r"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除WEB登录用户组

删除指定 ID 的 WEB 登录用户组。 使用前建议确认没有账号仍在引用该组。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录用户组 ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

查询账号是否需要修改密码

查询指定 WEB 登录账号当前是否需要修改密码。

返回说明：

  • mod_passwd = 0：当前不需要修改密码
  • mod_passwd = 1：当前密码为默认密码，需要修改
Authorizations:
bearerAuth
query Parameters
username
required
string
Example: username=admin

要查询的 WEB 登录账号用户名

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

修改WEB登录账号密码

修改当前 WEB 登录账号的密码。

Authorizations:
bearerAuth
Request Body schema: application/json
required

WEB 登录账号密码更新数据

passwd
required
string^[a-fA-F0-9]{32}$

新密码的 MD5 值

Responses

Request samples

Content type
application/json
{
  • "passwd": "0192023a7bbd73250516f069df18b500"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

获取WEB登录账号列表

获取 WEB 管理后台登录账号列表。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码，从 1 开始

limit
integer >= 1
Default: 50
Example: limit=50

每页返回记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

新增WEB登录账号

新增一个 WEB 管理后台登录账号。

建议先调用 /api/v4.0/system/web-admin/groups 创建用户组，再新增账号。

Authorizations:
bearerAuth
Request Body schema: application/json
required

WEB 登录账号创建数据

username
required
string

用户名

passwd
required
string^[a-fA-F0-9]{32}$

登录密码的 MD5 值

enabled
required
string
Enum: "yes" "no"

账号状态，yes 为启用，no 为停用

group_id
required
integer >= 1

所属用户组 ID。账号权限由该用户组提供，应先创建用户组再新增账号

force
required
integer
Enum: 0 1

定期修改密码开关

interval
required
integer >= 1

定期修改密码周期，单位天，最小值 1，默认 30

sesstimeout
required
integer >= 5

会话超时时间，单位分钟，最小值 5

comment
string <= 255 characters

备注信息

Responses

Request samples

Content type
application/json
{
  • "username": "ops_admin",
  • "passwd": "0192023a7bbd73250516f069df18b500",
  • "enabled": "yes",
  • "group_id": 1,
  • "force": 0,
  • "interval": 30,
  • "sesstimeout": 120,
  • "comment": "运维管理员账号"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success",
  • "rowid": 3
}

获取单个WEB登录账号详情

根据 ID 获取单个 WEB 登录账号详情。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录账号 ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

全量修改WEB登录账号

全量修改指定 ID 的 WEB 登录账号。

账号权限与安全地址范围由 group_id 关联的用户组统一定义。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录账号 ID

Request Body schema: application/json
required

WEB 登录账号更新数据

username
required
string

用户名

passwd
required
string^[a-fA-F0-9]{32}$

登录密码的 MD5 值

enabled
required
string
Enum: "yes" "no"

账号状态，yes 为启用，no 为停用

group_id
required
integer >= 1

所属用户组 ID。账号权限由该用户组提供

force
required
integer
Enum: 0 1

定期修改密码开关

interval
required
integer >= 1

定期修改密码周期，单位天，最小值 1，默认 30

sesstimeout
required
integer >= 5

会话超时时间，单位分钟，最小值 5

comment
string <= 255 characters

备注信息

Responses

Request samples

Content type
application/json
{
  • "username": "ops_admin",
  • "passwd": "0192023a7bbd73250516f069df18b500",
  • "enabled": "yes",
  • "group_id": 1,
  • "force": 0,
  • "interval": 30,
  • "sesstimeout": 120,
  • "comment": "更新后的备注"
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除WEB登录账号

删除指定 ID 的 WEB 登录账号。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

WEB 登录账号 ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}