文档首页
API docs by Redocly

爱快 OpenAPI - 分流与路由 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

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

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

静态路由策略管理API

来源文件: route/network-static-routes.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、tagname、interface、prio等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=prio>1&filter=interface==eth0
  • OR条件：filter=dst_addr==192.168.1.0,filter=dst_addr==192.168.2.0

Responses

Response samples

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

添加静态路由策略

创建新的静态路由策略。需要指定目标地址、网关、接口等路由信息。 支持IPv4和IPv6地址类型。

Authorizations:
bearerAuth
Request Body schema: application/json
required

静态路由配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

策略状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

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

interface
required
string
Default: "auto"

路由接口，auto为自动选择

dst_addr
required
string

目的地址

netmask
required
string

网络掩码

gateway
string

网关地址

prio
required
integer [ 1 .. 99 ]
Default: 1

优先级（1-99，数值越小优先级越高）

ip_type
required
string
Default: "4"
Enum: "4" "6"

IP类型，4为IPv4（默认），6为IPv6

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "route_to_lan",
  • "comment": "路由到内网段",
  • "interface": "lan1",
  • "dst_addr": "192.168.2.0",
  • "netmask": "255.255.255.0",
  • "gateway": "192.168.1.1",
  • "prio": 1,
  • "ip_type": "4"
}

Response samples

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

获取指定静态路由策略

获取指定ID的静态路由策略详细信息

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

静态路由策略ID

Responses

Response samples

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

更新静态路由策略

完全更新指定ID的静态路由策略

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

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

静态路由策略ID

Request Body schema: application/json
required

静态路由配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

策略状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
required
string <= 64 characters
Default: ""

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

interface
required
string
Default: "auto"

路由接口，auto为自动选择

dst_addr
required
string

目的地址

netmask
required
string

网络掩码

gateway
required
string

网关地址

prio
required
integer [ 1 .. 99 ]
Default: 1

优先级（1-99，数值越小优先级越高）

ip_type
required
string
Default: "4"
Enum: "4" "6"

IP类型，4为IPv4（默认），6为IPv6

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "route_to_lan",
  • "comment": "",
  • "interface": "wan1",
  • "dst_addr": "192.168.2.0",
  • "netmask": "255.255.255.0",
  • "gateway": "192.168.1.1",
  • "prio": 1,
  • "ip_type": "4"
}

Response samples

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

启用/停用静态路由策略

启用或停用指定ID的静态路由策略

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为停用

Responses

Request samples

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

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
{
  • "code": 0,
  • "message": "Success"
}

域名分流策略管理API

来源文件: route/network-stream-domain.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、tagname、interface、prio等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=prio>10&filter=interface==wan2
  • OR条件：filter=tagname==rule1,filter=tagname==rule2

Responses

Response samples

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

添加域名分流策略

创建新的域名分流策略。支持基于域名的流量分流到指定接口。 可配置源地址、域名列表、生效时间等复杂条件。

Authorizations:
bearerAuth
Request Body schema: application/json
required

域名分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

required
object (route_network_stream_domain_DomainObjectInput)

域名对象输入

interface
required
string

线路接口

prio
required
integer [ 0 .. 63 ]
Default: 31

优先级（0-63，0最高）

object (route_network_stream_domain_SrcAddrObjectInput)

源地址对象输入

object (route_network_stream_domain_TimeObjectInput)

生效时间对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "domain_rule_1",
  • "comment": "",
  • "domain": {
    },
  • "interface": "wan2",
  • "prio": 31,
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

获取指定域名分流策略

获取指定ID的域名分流策略详细信息

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

域名分流策略ID

Responses

Response samples

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

更新域名分流策略

完全更新指定ID的域名分流策略

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

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

域名分流策略ID

Request Body schema: application/json
required

域名分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

required
object (route_network_stream_domain_DomainObjectInput)

域名对象输入

interface
required
string

线路接口

prio
required
integer [ 0 .. 63 ]
Default: 31

优先级（0-63，0最高）

object (route_network_stream_domain_SrcAddrObjectInput)

源地址对象输入

object (route_network_stream_domain_TimeObjectInput)

生效时间对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "domain_rule_1",
  • "comment": "",
  • "domain": {
    },
  • "interface": "wan2",
  • "prio": 31,
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

启用/停用域名分流策略

启用或停用指定ID的域名分流策略

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

域名分流策略ID

Request Body schema: application/json
required

策略状态更新数据

enabled
required
string
Enum: "yes" "no"

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

Responses

Request samples

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

Response samples

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

删除域名分流策略

删除指定ID的域名分流策略

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

域名分流策略ID

Responses

Response samples

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

端口分流策略管理API

来源文件: route/network-stream-ipport.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、tagname、interface、prio等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=prio>10&filter=type==0
  • OR条件：filter=tagname==rule1,filter=tagname==rule2

Responses

Response samples

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

添加端口分流策略

创建新的端口分流策略。支持基于五元组（源地址、目的地址、协议、源端口、目的端口）的流量分流。 可配置wan转发或lan转发，支持负载均衡和地区分流。

Authorizations:
bearerAuth
Request Body schema: application/json
required

端口分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

type
required
integer
Default: 0
Enum: 0 1

转发方式，0:wan转发（默认）, 1:lan转发

nexthop
string
Default: ""

下一跳路由网关（lan转发生效）

interface
required
string

路由接口（wan转发生效）

mode
required
integer
Default: 0
Enum: 0 1 2 3 4 6

负载均衡方式 0: 新建连接 1:sip 2:sip+sport 3:sip+dip 4:sip+dip+dport 5:sip+sport+dip+dport 6:主备模式

prio
required
integer [ 0 .. 63 ]
Default: 31

优先级（0-63，0最高）

required
object (route_network_stream_ipport_SrcAddrObjectInput)

源地址对象输入

dst_addr
required
object (route_network_stream_ipport_DstAddrObjectInput)

目的地址对象输入

protocol
required
string
Enum: "any" "tcp" "udp" "tcp+udp" "icmp"

协议类型

src_port
required
object (route_network_stream_ipport_PortObjectInput)

端口对象输入

dst_port
required
object (route_network_stream_ipport_PortObjectInput)

端口对象输入

dst_type
integer
Default: 0
Enum: 0 1

目的类型，0:目的地址（默认）, 1:目的地区

area_code
string
Default: ""

地区代码

iface_band
required
integer
Default: 0
Enum: 0 1

是否绑定接口，0:不绑定（默认）, 1:绑定

required
object (route_network_stream_ipport_TimeObjectInput)

生效时间对象输入

src_addr_inv
required
integer
Default: 0
Enum: 0 1

源地址取反，0:不取反（默认），1:取反

dst_addr_inv
required
integer
Default: 0
Enum: 0 1

目的地址取反，0:不取反（默认），1:取反

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "port_rule_1",
  • "type": 0,
  • "interface": "wan2",
  • "protocol": "tcp",
  • "prio": 31,
  • "mode": 0,
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

获取指定端口分流策略

获取指定ID的端口分流策略详细信息

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

端口分流策略ID

Responses

Response samples

Content type
application/json
{
  • "message": "success",
  • "data": {
    }
}

更新端口分流策略

完全更新指定ID的端口分流策略

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

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

端口分流策略ID

Request Body schema: application/json
required

端口分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

type
required
integer
Default: 0
Enum: 0 1

转发方式，0:wan转发（默认）, 1:lan转发

nexthop
string
Default: ""

下一跳路由网关（lan转发生效）

interface
required
string

路由接口（wan转发生效）

mode
required
integer
Default: 0
Enum: 0 1 2 3 4 6

负载均衡方式 0: 新建连接 1:sip 2:sip+sport 3:sip+dip 4:sip+dip+dport 5:sip+sport+dip+dport 6:主备模式

prio
required
integer [ 0 .. 63 ]
Default: 31

优先级（0-63，0最高）

required
object (route_network_stream_ipport_SrcAddrObjectInput)

源地址对象输入

dst_addr
required
object (route_network_stream_ipport_DstAddrObjectInput)

目的地址对象输入

protocol
required
string
Enum: "any" "tcp" "udp" "tcp+udp" "icmp"

协议类型

src_port
required
object (route_network_stream_ipport_PortObjectInput)

端口对象输入

dst_port
required
object (route_network_stream_ipport_PortObjectInput)

端口对象输入

dst_type
integer
Default: 0
Enum: 0 1

目的类型，0:目的地址（默认）, 1:目的地区

area_code
string
Default: ""

地区代码

iface_band
required
integer
Default: 0
Enum: 0 1

是否绑定接口，0:不绑定（默认）, 1:绑定

required
object (route_network_stream_ipport_TimeObjectInput)

生效时间对象输入

src_addr_inv
required
integer
Default: 0
Enum: 0 1

源地址取反，0:不取反（默认），1:取反

dst_addr_inv
required
integer
Default: 0
Enum: 0 1

目的地址取反，0:不取反（默认），1:取反

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "port_rule_1",
  • "comment": "",
  • "type": 0,
  • "nexthop": "",
  • "interface": "wan2",
  • "protocol": "tcp",
  • "prio": 31,
  • "mode": 0,
  • "iface_band": 0,
  • "src_addr_inv": 0,
  • "dst_addr_inv": 0,
  • "src_addr": {
    },
  • "dst_addr": { },
  • "src_port": { },
  • "dst_port": { },
  • "dst_type": 0,
  • "area_code": "",
  • "time": {
    }
}

Response samples

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

启用/停用端口分流策略

启用或停用指定ID的端口分流策略

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

端口分流策略ID

Request Body schema: application/json
required

策略状态更新数据

enabled
required
string
Enum: "yes" "no"

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

Responses

Request samples

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

Response samples

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

删除端口分流策略

删除指定ID的端口分流策略

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

端口分流策略ID

Responses

Response samples

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

协议分流策略管理API

来源文件: route/network-stream-l7.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、tagname、interface、prio等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=prio>10&filter=interface==wan2
  • OR条件：filter=tagname==rule1,filter=tagname==rule2

Responses

Response samples

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

添加协议分流策略

创建新的协议分流策略。支持基于应用协议的流量分流到指定接口。 可配置源地址、应用协议列表、生效时间等复杂条件。

Authorizations:
bearerAuth
Request Body schema: application/json
required

协议分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

名称，支持中文、英文、数字、下划线和连字符，1-15个字符，不能以下划线或连字符开头

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

interface
required
string

线路接口

mode
required
integer
Default: 0
Enum: 0 1 3

负载方式 0: 新建连接 1:sip 3:sip+dip

prio
required
integer [ 0 .. 63 ]

优先级（0-63，0最高）

object (route_network_stream_l7_SrcAddrObjectInput)

源地址对象输入

required
object (route_network_stream_l7_AppProtoObjectInput)

应用协议对象输入

iface_band
required
integer
Default: 0
Enum: 0 1

是否绑定接口，0:不绑定（默认）, 1:绑定

object (route_network_stream_l7_TimeObjectInput)

生效时间对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "test3",
  • "comment": "",
  • "interface": "wan2",
  • "mode": 0,
  • "prio": 1,
  • "iface_band": 0,
  • "src_addr": {
    },
  • "app_proto": {
    },
  • "time": {
    }
}

Response samples

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

获取指定协议分流策略

获取指定ID的协议分流策略详细信息

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

协议分流策略ID

Responses

Response samples

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

更新协议分流策略

完全更新指定ID的协议分流策略

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

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

协议分流策略ID

Request Body schema: application/json
required

协议分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

名称，支持中文、英文、数字、下划线和连字符，1-15个字符，不能以下划线或连字符开头

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

interface
required
string

线路接口

mode
required
integer
Default: 0
Enum: 0 1 3

负载方式 0: 新建连接 1:sip 3:sip+dip

prio
required
integer [ 0 .. 63 ]

优先级（0-63，0最高）

object (route_network_stream_l7_SrcAddrObjectInput)

源地址对象输入

required
object (route_network_stream_l7_AppProtoObjectInput)

应用协议对象输入

iface_band
required
integer
Default: 0
Enum: 0 1

是否绑定接口，0:不绑定（默认）, 1:绑定

object (route_network_stream_l7_TimeObjectInput)

生效时间对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "test3",
  • "comment": "",
  • "interface": "wan2",
  • "mode": 0,
  • "prio": 1,
  • "iface_band": 0,
  • "src_addr": {
    },
  • "app_proto": {
    },
  • "time": {
    }
}

Response samples

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

启用/停用协议分流策略

启用或停用指定ID的协议分流策略

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为停用

Responses

Request samples

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

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"
}

多线负载分流策略管理API

来源文件: route/network-stream-load.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、tagname、interface、mode等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=mode>0&filter=interface==wan2
  • OR条件：filter=tagname==rule1,filter=tagname==rule2

Responses

Response samples

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

添加多线负载分流策略

创建新的多线负载分流策略。支持多种负载均衡模式和线路权重配置。 可配置不同的运营商线路和负载权重。

Authorizations:
bearerAuth
Request Body schema: application/json
required

多线负载分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

interface
required
string

线路名称

weight
required
string^([1-9]|10)$
Default: "1"

负载比重（1-10）

mode
required
integer
Enum: 0 1 2 3 4 6 7

负载模式(0:源IP+目的IP+目的端口,1:源IP+目的IP,2:新建连接数,3:实时流量,4:实时连接数,6:源IP,7:源IP+源端口)

isp_name
required
string
Default: ""

运营商名称，内置值：all（全部）、chinatelecom（电信）、chinaunicom（联通）、chinamobile（移动）、chinacernet（教育网），或自定义运营商名称

Responses

Request samples

Content type
application/json
{
  • "mode": 0,
  • "comment": "111",
  • "isp_name": "all",
  • "interface": "wan2",
  • "weight": "1",
  • "enabled": "yes",
  • "tagname": "11"
}

Response samples

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

获取指定多线负载分流策略

获取指定ID的多线负载分流策略详细信息

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

多线负载分流策略ID

Responses

Response samples

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

更新多线负载分流策略

完全更新指定ID的多线负载分流策略

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

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

多线负载分流策略ID

Request Body schema: application/json
required

多线负载分流策略配置数据

enabled
required
string
Default: "yes"
Enum: "yes" "no"

规则状态，yes为启用（默认），no为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

备注信息，最多64个字符

interface
required
string

线路名称

weight
required
string^([1-9]|10)$
Default: "1"

负载比重（1-10）

mode
required
integer
Enum: 0 1 2 3 4 6 7

负载模式(0:源IP+目的IP+目的端口,1:源IP+目的IP,2:新建连接数,3:实时流量,4:实时连接数,6:源IP,7:源IP+源端口)

isp_name
required
string
Default: ""

运营商名称，内置值：all（全部）、chinatelecom（电信）、chinaunicom（联通）、chinamobile（移动）、chinacernet（教育网），或自定义运营商名称

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "11",
  • "comment": "111",
  • "interface": "wan2",
  • "weight": "1",
  • "mode": 0,
  • "isp_name": "all"
}

Response samples

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

启用/停用多线负载分流策略

启用或停用指定ID的多线负载分流策略

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为停用

Responses

Request samples

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

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"
}

上下行分离策略管理API

来源文件: route/network-stream-updown.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、tagname、upiface、downiface等字段

filter
string
Example: filter=enabled==yes

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • ==（等于）
  • !=（不等于）

  • （大于）

  • =（大于等于）

  • <（小于）
  • <=（小于等于）

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,filter=field2==value2

使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=upiface==wan1&filter=protocol==tcp
  • OR条件：filter=tagname==rule1,filter=tagname==rule2

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为停用

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

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

upiface
required
string

上行接口（WAN口）

downiface
required
string

下行接口（WAN口）

object (route_network_stream_updown_SrcAddrObjectInput)

源地址对象输入

object (route_network_stream_updown_DstAddrObjectInput)

目的地址对象输入

protocol
string
Default: "any"
Enum: "any" "tcp" "udp" "tcp+udp" "icmp"

协议类型

object (route_network_stream_updown_PortObjectInput)

端口对象输入

object (route_network_stream_updown_PortObjectInput)

端口对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "iKuai-UpDown",
  • "upiface": "wan1",
  • "downiface": "wan2",
  • "protocol": "tcp",
  • "src_addr": {
    }
}

Response samples

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

获取指定上下行分离策略

获取指定ID的上下行分离策略详细信息

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

上下行分离策略ID

Responses

Response samples

Content type
application/json
{
  • "message": "success",
  • "data": {
    }
}

更新上下行分离策略

完全更新指定ID的上下行分离策略

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

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

上下行分离策略ID

Request Body schema: application/json
required

上下行分离策略配置数据

enabled
required
string
Enum: "yes" "no"

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

tagname
required
string [ 1 .. 15 ] characters

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

comment
string <= 64 characters
Default: ""

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

upiface
required
string

上行接口（WAN口）

downiface
required
string

下行接口（WAN口）

object (route_network_stream_updown_SrcAddrObjectInput)

源地址对象输入

object (route_network_stream_updown_DstAddrObjectInput)

目的地址对象输入

protocol
string
Default: "any"
Enum: "any" "tcp" "udp" "tcp+udp" "icmp"

协议类型

object (route_network_stream_updown_PortObjectInput)

端口对象输入

object (route_network_stream_updown_PortObjectInput)

端口对象输入

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "iKuai-UpDown",
  • "comment": "",
  • "upiface": "wan1",
  • "downiface": "wan2",
  • "protocol": "tcp",
  • "src_addr": {
    },
  • "src_port": {
    },
  • "dst_port": {
    }
}

Response samples

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

启用/停用上下行分离策略

启用或停用指定ID的上下行分离策略

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

上下行分离策略ID

Request Body schema: application/json
required

策略状态更新数据

enabled
required
string
Enum: "yes" "no"

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

Responses

Request samples

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

Response samples

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

删除上下行分离策略

删除指定ID的上下行分离策略

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

上下行分离策略ID

Responses

Response samples

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