文档首页
API docs by Redocly

爱快 OpenAPI - 安全 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

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

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

应用协议控制API

来源文件: security/security-acl-l7.json

获取应用协议控制策略列表

获取应用协议控制策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&action==drop

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、action、app_proto、prio等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=action==drop
  • OR条件：filter=app_proto==HTTP,filter=app_proto==HTTPS
  • 优先级范围：filter=prio>=10&filter=prio<=50
order
string
Default: "prio"
Enum: "prio" "id" "create_time"

排序字段（prio, id, create_time等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建应用协议控制策略

创建新的应用协议控制策略，支持多种应用协议识别和控制动作

Authorizations:
bearerAuth
Request Body schema: application/json
required

应用协议控制策略配置数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

comment
string <= 64 characters

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

prio
required
integer [ 0 .. 63 ]

规则优先级（0~63, 0最高）

action
required
string
Enum: "accept" "drop"

动作类型

required
object (security_security_acl_l7_AppProtocolObject)
object (security_security_acl_l7_AddressObject)
object (security_security_acl_l7_AddressObject)
object (security_security_acl_l7_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "",
  • "prio": 31,
  • "action": "drop",
  • "app_proto": {
    },
  • "src_addr": "",
  • "time": {
    },
  • "dst_addr": "",
  • "tagname": "33"
}

Response samples

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

获取单个应用协议控制策略

根据ID获取指定的应用协议控制策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

应用协议控制策略ID

Responses

Response samples

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

更新应用协议控制策略

完整更新指定的应用协议控制策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

应用协议控制策略ID

Request Body schema: application/json
required

应用协议控制策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

comment
required
string <= 64 characters

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

prio
required
integer [ 0 .. 63 ]

规则优先级（0~63, 0最高）

action
required
string
Enum: "accept" "drop"

动作类型

required
object (security_security_acl_l7_AppProtocolObject)
required
object (security_security_acl_l7_AddressObject)
required
object (security_security_acl_l7_AddressObject)
object (security_security_acl_l7_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "",
  • "prio": 31,
  • "action": "drop",
  • "app_proto": {
    },
  • "src_addr": "",
  • "time": {
    },
  • "dst_addr": "",
  • "tagname": "33"
}

Response samples

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

启用/停用应用协议控制策略

切换应用协议控制策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 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 >= 1

应用协议控制策略ID

Responses

Response samples

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

MAC访问控制API

来源文件: security/security-acl-mac.json

获取MAC黑白名单模式

获取当前配置的MAC访问控制模式（黑名单或白名单模式）

Authorizations:
bearerAuth

Responses

Response samples

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

设置MAC黑白名单模式

配置MAC访问控制模式，可选择黑名单模式或白名单模式。

  • 黑名单模式：阻止指定的MAC地址访问
  • 白名单模式：仅允许指定的MAC地址访问

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

Authorizations:
bearerAuth
Request Body schema: application/json
required

MAC访问控制模式配置

acl_mac
required
integer
Enum: 0 1

MAC访问控制模式

Responses

Request samples

Content type
application/json
{
  • "acl_mac": 1
}

Response samples

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

获取MAC黑白名单策略列表

获取MAC地址黑白名单策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&mac==08:9b:4b:00:10:2e

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、mac、tagname、expires等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=expires==0
  • OR条件：filter=mac==08:9b:4b:00:10:2e,filter=mac==08:9b:4b:00:10:1e
order
string
Default: "id"
Enum: "id" "create_time" "mac"

排序字段（id, create_time等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建MAC黑白名单策略

创建新的MAC地址黑白名单策略，支持时间规则控制

Authorizations:
bearerAuth
Request Body schema: application/json
required

MAC策略配置数据

mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC地址

enabled
required
string
Enum: "yes" "no"

策略状态

tagname
required
string

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

comment
string

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

object (security_security_acl_mac_TimeObject)
expires
required
integer >= 0
Default: 0

到期时间，Unix时间戳，0表示永不过期

termname
string

终端名称

Responses

Request samples

Content type
application/json
{
  • "mac": "08:9b:4b:00:10:2e",
  • "enabled": "yes",
  • "comment": "111",
  • "time": {
    },
  • "tagname": "aaaa"
}

Response samples

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

获取单个MAC策略

根据ID获取指定的MAC策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

MAC策略ID

Responses

Response samples

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

更新MAC策略

完整更新指定的MAC策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

MAC策略ID

Request Body schema: application/json
required

MAC策略更新数据

mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC地址

enabled
required
string
Enum: "yes" "no"

策略状态

tagname
required
string

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

comment
string

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

object (security_security_acl_mac_TimeObject)
expires
required
integer >= 0
Default: 0

到期时间，Unix时间戳，0表示永不过期

termname
string

终端名称

Responses

Request samples

Content type
application/json
{
  • "mac": "08:9b:4b:00:10:2e",
  • "enabled": "yes",
  • "comment": "111",
  • "expires": 0,
  • "time": {
    },
  • "tagname": "aaaa"
}

Response samples

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

启用/停用MAC策略

切换MAC策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

MAC策略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"
}

删除MAC策略

删除指定的MAC策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

MAC策略ID

Responses

Response samples

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

ACL访问控制列表API

来源文件: security/security-acl.json

获取ACL策略列表

获取ACL访问控制策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&action==drop

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、action、protocol、ip_type、dir、prio等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=action==drop
  • OR条件：filter=protocol==tcp,filter=protocol==udp
  • 优先级范围：filter=prio>=10&filter=prio<=50
order
string
Default: "prio"
Enum: "prio" "create_time" "id"

排序字段（prio, create_time等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建ACL策略

创建新的ACL访问控制策略，支持IPv4/IPv6地址、协议、端口等条件的过滤控制

Authorizations:
bearerAuth
Request Body schema: application/json
required

ACL策略配置数据

action
required
string
Enum: "accept" "drop"

动作

dir
required
string
Enum: "input" "forward"

流量方向

ctdir
required
integer
Default: 0
Enum: 0 1 2

连接方向匹配（0:关闭, 1:ORIGINAL方向, 2:REPLY方向）

iinterface
required
string

入接口

ointerface
required
string

出接口

object (security_security_acl_AddressObject)
src_addr_inv
required
integer
Default: 0
Enum: 0 1

源地址取反(0:不取反, 1:取反)

object (security_security_acl_AddressObject)
dst_addr_inv
required
integer
Default: 0
Enum: 0 1

目的地址取反(0:不取反, 1:取反)

src_type
integer
Default: 0
Enum: 0 1

源类型(0:IP, 1:IP归属地)

src_area_code
string

源地区归属地代码（国家/省/市代码）

dst_type
integer
Default: 0
Enum: 0 1

目的类型(0:IP, 1:IP归属地)

dst_area_code
string

目的地区归属地代码

object (security_security_acl_AddressObject)
object (security_security_acl_AddressObject)
src6_mode
required
integer
Default: 0
Enum: 0 1

IPv6源后缀匹配(0:关闭, 1:开启)

dst6_mode
required
integer
Default: 0
Enum: 0 1

IPv6目的后缀匹配(0:关闭, 1:开启)

src6_suffix
string

IPv6后缀源地址

dst6_suffix
string

IPv6后缀目的地址

prio
required
integer [ 0 .. 63 ]

优先级(0-63, 0最高)

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

协议类型，IPv4支持：tcp/udp/tcp+udp/icmp/gre/any；IPv6支持：tcp/udp/icmpv6/any

object (security_security_acl_PortObject)
object (security_security_acl_PortObject)
object (security_security_acl_TimeObject)
ip_type
required
string
Enum: "4" "6"

IP类型

enabled
required
string
Enum: "yes" "no"

策略状态

comment
string <= 64 characters

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

tagname
required
string [ 1 .. 15 ] characters

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

Responses

Request samples

Content type
application/json
{
  • "protocol": "any",
  • "action": "drop",
  • "dir": "forward",
  • "ctdir": 0,
  • "iinterface": "any",
  • "ointerface": "any",
  • "src_addr": {
    },
  • "src_addr_inv": 0,
  • "dst_addr": "",
  • "dst_addr_inv": 0,
  • "dst_port": "",
  • "src_type": 0,
  • "dst_type": 0,
  • "comment": "hylitest",
  • "enabled": "yes",
  • "ip_type": "4",
  • "src6_addr": "",
  • "dst6_addr": "",
  • "src6_mode": 1,
  • "dst6_mode": 0,
  • "src6_suffix": "::abcd::ffff",
  • "dst6_suffix": "",
  • "src_area_code": "",
  • "dst_area_code": "",
  • "prio": 10,
  • "time": {
    },
  • "tagname": "053"
}

Response samples

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

获取单个ACL策略

根据ID获取指定的ACL策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

ACL策略ID

Responses

Response samples

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

更新ACL策略

完整更新指定的ACL策略配置。

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

ACL策略ID

Request Body schema: application/json
required

ACL策略更新数据（全量修改，所有字段必填）

action
required
string
Enum: "accept" "drop"

动作

dir
required
string
Enum: "input" "forward"

流量方向

ctdir
required
integer
Enum: 0 1 2

连接方向匹配（0:关闭, 1:ORIGINAL方向, 2:REPLY方向）

iinterface
required
string

入接口

ointerface
required
string

出接口

required
object (security_security_acl_AddressObject)
required
object (security_security_acl_AddressObject)
src_addr_inv
required
integer
Enum: 0 1

源地址取反(0:不取反, 1:取反)

dst_addr_inv
required
integer
Enum: 0 1

目的地址取反(0:不取反, 1:取反)

src_type
required
integer
Enum: 0 1

源类型(0:IP, 1:IP归属地)

src_area_code
required
string

源地区归属地代码

dst_type
required
integer
Enum: 0 1

目的类型(0:IP, 1:IP归属地)

dst_area_code
required
string

目的地区归属地代码

required
object (security_security_acl_AddressObject)
required
object (security_security_acl_AddressObject)
src6_mode
required
integer
Enum: 0 1

IPv6源后缀匹配(0:关闭, 1:开启)

dst6_mode
required
integer
Enum: 0 1

IPv6目的后缀匹配(0:关闭, 1:开启)

src6_suffix
required
string

IPv6后缀源地址

dst6_suffix
required
string

IPv6后缀目的地址

prio
required
integer [ 0 .. 63 ]

优先级(0-63, 0最高)

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

协议类型，IPv4支持：tcp/udp/tcp+udp/icmp/gre/any；IPv6支持：tcp/udp/icmpv6/any

required
object (security_security_acl_PortObject)
required
object (security_security_acl_PortObject)
required
object (security_security_acl_TimeObject)
ip_type
required
string
Enum: "4" "6"

IP类型

enabled
required
string
Enum: "yes" "no"

策略状态

comment
required
string <= 64 characters

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

tagname
required
string [ 1 .. 15 ] characters

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

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "hylitest",
  • "dir": "forward",
  • "ctdir": 0,
  • "action": "drop",
  • "iinterface": "any",
  • "ointerface": "any",
  • "src_addr": {
    },
  • "dst_addr": "",
  • "src_addr_inv": 0,
  • "dst_addr_inv": 0,
  • "protocol": "any",
  • "src_port": "",
  • "dst_port": "",
  • "time": {
    },
  • "ip_type": "4",
  • "src6_addr": "",
  • "dst6_addr": "",
  • "src6_mode": 0,
  • "dst6_mode": 0,
  • "src6_suffix": "",
  • "dst6_suffix": "",
  • "src_type": 0,
  • "src_area_code": "",
  • "dst_type": 0,
  • "dst_area_code": "",
  • "prio": 10,
  • "tagname": "053"
}

Response samples

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

启用/停用ACL策略

切换ACL策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

ACL策略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"
}

删除ACL策略

删除指定的ACL策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

ACL策略ID

Responses

Response samples

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

安全中心高级设置API

来源文件: security/security-advanced.json

获取安全中心高级设置

获取当前配置的安全中心高级设置参数

Authorizations:
bearerAuth

Responses

Response samples

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

更新安全中心高级设置

更新安全中心的高级设置参数，包括各种网络安全防护和连接限制配置

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

Authorizations:
bearerAuth
Request Body schema: application/json
required

安全中心高级设置配置数据

noping_lan
required
integer
Default: 0
Enum: 0 1

禁止内网Ping（0:禁用, 1:启用）

noping_wan
required
integer
Default: 0
Enum: 0 1

禁止外网Ping（0:禁用, 1:启用）

notracert
required
integer
Default: 0
Enum: 0 1

禁止tracert追踪（0:禁用, 1:启用）

hijack_ping
required
integer
Default: 0
Enum: 0 1

劫持Ping（0:禁用, 1:启用）

invalid
required
integer
Default: 0
Enum: 0 1

禁止无效链接（0:禁用, 1:启用）

dos_lan
required
integer
Default: 0
Enum: 0 1

内网DOS防御（0:禁用, 1:启用）

dos_lan_num
required
integer [ 1 .. 10000 ]
Default: 300

内网DOS连接数限制

tcp_mss
required
integer
Default: 1
Enum: 0 1

启用TCPMSS最大报文长度（0:禁用, 1:启用）

tcp_mss_num
required
integer [ 500 .. 1500 ]
Default: 1400

TCPMSS最大报文长度

Responses

Request samples

Content type
application/json
{
  • "noping_lan": 0,
  • "noping_wan": 1,
  • "notracert": 0,
  • "hijack_ping": 0,
  • "invalid": 1,
  • "dos_lan": 1,
  • "dos_lan_num": 500,
  • "tcp_mss": 1,
  • "tcp_mss_num": 1460
}

Response samples

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

域名黑名单API

来源文件: security/security-domain-blacklist.json

获取域名黑名单策略列表

获取域名黑名单策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&domain_group==购物网站

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、domain_group、tagname等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=domain_group==购物网站
  • OR条件：filter=domain_group==购物网站,filter=domain_group==游戏网站
  • 域名组模糊匹配：filter=domain_group==购物
  • 规则名称过滤：filter=tagname==test_rule
order
string
Default: "id"
Enum: "id" "domain_group"

排序字段（id, domain_group等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建域名黑名单策略

创建新的域名黑名单策略，支持域名组过滤和时间规则控制

Authorizations:
bearerAuth
Request Body schema: application/json
required

域名黑名单策略配置数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

comment
string

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

domain_group
required
string

域名分组，多个分组用逗号分隔。可选值：

  • 交通旅游：旅游网站、旅行社、票务预订、酒店宾馆
  • 休闲娱乐：动漫网站、娱乐时尚、小说网站、幽默笑话、收藏爱好、星座运势、游戏网站、社交网站、视频电影、音乐网站
  • 体育健身：体育综合、极限运动、棋牌健身、球类运动、福彩体彩
  • 医疗健康：健康保健、美容整形
  • 新闻媒体：广播电视、新闻报刊
  • 生活服务：宠物玩具、求职招聘、汽车网站、餐饮美食
  • 论坛门户：博客网站、搜索引擎、网址导航、论坛综合
  • 购物网站：团购网站、电商网站、购物分享、返利比价
  • 金融理财：网贷平台、证券网站、金融财经、银行保险
object (security_security_domain_blacklist_AddressObject)
object (security_security_domain_blacklist_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "",
  • "time": {
    },
  • "domain_group": "购物网站",
  • "src_addr": {
    },
  • "tagname": "11"
}

Response samples

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

获取单个域名黑名单策略

根据ID获取指定的域名黑名单策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

域名黑名单策略ID

Responses

Response samples

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

更新域名黑名单策略

完整更新指定的域名黑名单策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

域名黑名单策略ID

Request Body schema: application/json
required

域名黑名单策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

comment
string

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

domain_group
required
string

域名分组，多个分组用逗号分隔。可选值：

  • 交通旅游：旅游网站、旅行社、票务预订、酒店宾馆
  • 休闲娱乐：动漫网站、娱乐时尚、小说网站、幽默笑话、收藏爱好、星座运势、游戏网站、社交网站、视频电影、音乐网站
  • 体育健身：体育综合、极限运动、棋牌健身、球类运动、福彩体彩
  • 医疗健康：健康保健、美容整形
  • 新闻媒体：广播电视、新闻报刊
  • 生活服务：宠物玩具、求职招聘、汽车网站、餐饮美食
  • 论坛门户：博客网站、搜索引擎、网址导航、论坛综合
  • 购物网站：团购网站、电商网站、购物分享、返利比价
  • 金融理财：网贷平台、证券网站、金融财经、银行保险
object (security_security_domain_blacklist_AddressObject)
object (security_security_domain_blacklist_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "11",
  • "comment": "",
  • "domain_group": "购物网站",
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

启用/停用域名黑名单策略

切换域名黑名单策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 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 >= 1

域名黑名单策略ID

Responses

Response samples

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

网络分享控制API

来源文件: security/security-l2-route.json

获取网络分享控制策略

获取当前配置的网络分享控制策略设置

Authorizations:
bearerAuth

Responses

Response samples

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

更新网络分享控制策略

更新网络分享控制策略配置，包括禁止二级路由、IP地址设置、TTL值等参数

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

Authorizations:
bearerAuth
Request Body schema: application/json
required

网络分享控制策略配置数据

nol2rt
required
integer
Default: 0
Enum: 0 1

禁止二级路由开关（0:允许, 1:禁止）

required
object (security_security_l2_route_AddressObject)
ttl_num
required
integer [ 1 .. 255 ]
Default: 1

自定义TTL值

required
object (security_security_l2_route_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "nol2rt": 0,
  • "nol2rt_ip": {
    },
  • "ttl_num": 1,
  • "time": ""
}

Response samples

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

终端名称管理API

来源文件: security/security-mac-comment.json

获取终端设备列表

获取终端设备列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=mac==08:9b:4b:00:10:6d

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：mac、tagname、comment等 使用示例：

  • 单条件：filter=mac==08:9b:4b:00:10:6d
  • AND条件：filter=mac==08:9b:4b:00:10:6d&filter=tagname==test11
  • OR条件：filter=tagname==test11,filter=tagname==device01
  • MAC前缀匹配：filter=mac==08:9b:4b:*
  • 设备名称模糊匹配：filter=tagname==test
  • 备注信息过滤：filter=comment!=空
order
string
Default: "id"
Enum: "id" "mac" "tagname"

排序字段（id, mac, tagname等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建终端设备名称

创建新的终端设备名称记录，支持MAC地址、设备名称和备注信息

Authorizations:
bearerAuth
Request Body schema: application/json
required

终端设备名称配置数据

mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC地址（唯一）

tagname
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

comment
string [ 0 .. 64 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

Responses

Request samples

Content type
application/json
{
  • "mac": "08:9b:4b:00:10:6d",
  • "tagname": "test11",
  • "comment": "comm_11"
}

Response samples

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

获取单个终端设备名称

根据ID获取指定的终端设备名称详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

终端设备ID

Responses

Response samples

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

更新终端设备名称

完整更新指定的终端设备名称配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

终端设备ID

Request Body schema: application/json
required

终端设备名称更新数据

mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC地址（唯一）

tagname
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

comment
string [ 0 .. 64 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9][\\u4e00-\\u9fa5a-...

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

Responses

Request samples

Content type
application/json
{
  • "mac": "08:9b:4b:00:10:6d",
  • "tagname": "test11",
  • "comment": "comm_11"
}

Response samples

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

删除终端设备名称

删除指定的终端设备名称记录

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

终端设备ID

Responses

Response samples

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

连接数限制API

来源文件: security/security-peerconn.json

获取连接数限制策略列表

获取连接数限制策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&protocol==udp

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、protocol、limits、tagname、dst_port等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=protocol==tcp
  • OR条件：filter=protocol==tcp,filter=protocol==udp
  • 连接数范围：filter=limits>=100&filter=limits<=10000
  • 端口过滤：filter=dst_port==80
  • 协议类型：filter=protocol==tcp (TCP) 或 filter==udp (UDP) 或 filter==any (任意协议)
order
string
Default: "id"
Enum: "id" "limits"

排序字段（id, limits等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建连接数限制策略

创建新的连接数限制策略，支持协议端口过滤和连接数阈值控制

Authorizations:
bearerAuth
Request Body schema: application/json
required

连接数限制策略配置数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

comment
string

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

object (security_security_peerconn_AddressObject)
protocol
required
string
Enum: "tcp" "udp" "any" "icmp" "gre"

协议类型

object (security_security_peerconn_PortObject)
limits
required
integer [ 1 .. 100000 ]

最大允许连接数限制

object (security_security_peerconn_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "src_addr": {
    },
  • "comment": "111",
  • "protocol": "udp",
  • "dst_port": {
    },
  • "time": {
    },
  • "limits": "10000",
  • "tagname": "conn_limit_44"
}

Response samples

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

获取单个连接数限制策略

根据ID获取指定的连接数限制策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

连接数限制策略ID

Responses

Response samples

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

更新连接数限制策略

完整更新指定的连接数限制策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

连接数限制策略ID

Request Body schema: application/json
required

连接数限制策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

comment
string

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

object (security_security_peerconn_AddressObject)
protocol
required
string
Enum: "tcp" "udp" "any" "icmp" "gre"

协议类型

object (security_security_peerconn_PortObject)
limits
required
integer [ 1 .. 100000 ]

最大允许连接数限制

object (security_security_peerconn_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "src_addr": {
    },
  • "comment": "111",
  • "protocol": "udp",
  • "dst_port": {
    },
  • "time": {
    },
  • "limits": "10000",
  • "tagname": "conn_limit_44"
}

Response samples

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

启用/停用连接数限制策略

切换连接数限制策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 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 >= 1

连接数限制策略ID

Responses

Response samples

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

URL黑白名单API

来源文件: security/security-url-black.json

获取URL黑白名单策略列表

获取URL黑白名单策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&mode==0

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、mode、tagname、domain等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=mode==0
  • OR条件：filter=domain==baidu.com,filter=domain==google.com
  • 黑白名单模式：filter=mode==0 (黑名单) 或 filter=mode==1 (白名单)
  • 域名前缀匹配：filter=domain==*.example.com
order
string
Default: "id"
Enum: "id" "domain"

排序字段（id, domain等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建URL黑白名单策略

创建新的URL黑白名单策略，支持域名过滤和时间规则控制

Authorizations:
bearerAuth
Request Body schema: application/json
required

URL黑白名单策略配置数据

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

comment
string

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

mode
required
string
Enum: "0" "1"

模式

required
object (security_security_url_black_DomainObject)
object (security_security_url_black_AddressObject)
object (security_security_url_black_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "",
  • "domain": {
    },
  • "src_addr": {
    },
  • "time": {
    },
  • "mode": "0",
  • "tagname": "11"
}

Response samples

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

获取单个URL黑白名单策略

根据ID获取指定的URL黑白名单策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL黑白名单策略ID

Responses

Response samples

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

更新URL黑白名单策略

完整更新指定的URL黑白名单策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL黑白名单策略ID

Request Body schema: application/json
required

URL黑白名单策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

comment
required
string

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

tagname
required
string

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

mode
required
string
Enum: "0" "1"

模式（0=黑名单, 1=白名单）

required
object (security_security_url_black_DomainObject)
required
object (security_security_url_black_AddressObject)
object (security_security_url_black_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "comment": "",
  • "domain": {
    },
  • "src_addr": {
    },
  • "time": {
    },
  • "mode": "0",
  • "tagname": "11"
}

Response samples

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

启用/停用URL黑白名单策略

切换URL黑白名单策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL黑白名单策略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"
}

删除URL黑白名单策略

删除指定的URL黑白名单策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL黑白名单策略ID

Responses

Response samples

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

URL关键字替换API

来源文件: security/security-url-keywords.json

获取URL关键字替换策略列表

获取URL关键字替换策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&mode==exact

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、mode、ori_keyword、rep_keyword、prio、hit_rate等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=mode==exact
  • OR条件：filter=ori_keyword==test,filter=rep_keyword==replace
  • 优先级范围：filter=prio>=1&filter=prio<=32
  • 替换率过滤：filter=hit_rate>=50
order
string
Default: "prio"
Enum: "prio" "id"

排序字段（prio, id）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建URL关键字替换策略

创建新的URL关键字替换策略，支持关键字匹配和替换功能

Authorizations:
bearerAuth
Request Body schema: application/json
required

URL关键字替换策略配置数据

prio
required
integer [ 0 .. 63 ]

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

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

object (security_security_url_keywords_AddressObject)
src_url
required
string

源URL

ori_keyword
required
string

原始关键字

rep_keyword
required
string

替换关键字

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

替换百分比（1-100）

object (security_security_url_keywords_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "comment": "444",
  • "prio": 1,
  • "src_addr": "",
  • "src_url": "192.168.1.253",
  • "ori_keyword": "qwe",
  • "rep_keyword": "456",
  • "mode": "exact",
  • "hit_rate": 100,
  • "id": 1,
  • "enabled": "yes",
  • "excluded": "",
  • "tagname": "test1"
}

Response samples

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

获取单个URL关键字替换策略

根据ID获取指定的URL关键字替换策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL关键字替换策略ID

Responses

Response samples

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

更新URL关键字替换策略

完整更新指定的URL关键字替换策略配置。

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL关键字替换策略ID

Request Body schema: application/json
required

URL关键字替换策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

prio
required
integer [ 1 .. 63 ]

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

required
object (security_security_url_keywords_AddressObject)
src_url
required
string

源URL

ori_keyword
required
string [ 1 .. 50 ] characters

原始关键字（1-50字符）

rep_keyword
required
string [ 1 .. 40 ] characters

替换关键字（1-40字符）

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
required
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

替换百分比（1-100）

required
object (security_security_url_keywords_TimeObject)
tagname
required
string

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

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "prio": 1,
  • "src_addr": {
    },
  • "src_url": "192.168.1.253",
  • "ori_keyword": "qwe",
  • "rep_keyword": "456",
  • "mode": "exact",
  • "excluded": "",
  • "hit_rate": 100,
  • "time": {
    },
  • "tagname": "test1"
}

Response samples

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

启用/停用URL关键字替换策略

切换URL关键字替换策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL关键字替换策略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"
}

删除URL关键字替换策略

删除指定的URL关键字替换策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL关键字替换策略ID

Responses

Response samples

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

URL跳转API

来源文件: security/security-url-redirect.json

获取URL跳转策略列表

获取URL跳转策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&mode==exact

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、mode、src_url、dst_url、prio、hit_rate等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=mode==exact
  • OR条件：filter=src_url==192.168.1.1,filter=dst_url==192.168.1.2
  • 优先级范围：filter=prio>=1&filter=prio<=63
  • 跳转率过滤：filter=hit_rate>=80
order
string
Default: "prio"
Enum: "prio" "id" "create_time"

排序字段（prio, id, create_time等）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建URL跳转策略

创建新的URL跳转策略，支持源地址过滤和目标URL跳转功能

Authorizations:
bearerAuth
Request Body schema: application/json
required

URL跳转策略配置数据

prio
required
integer [ 1 .. 63 ]

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

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

名称，支持中文、英文、数字、下划线和连字符，1-15个字符，不能以下划线或连字符开头；同时作为规则备注（comment），两者含义相同

object (security_security_url_redirect_AddressObject)
src_url
required
string

源URL

dst_url
required
string

目的URL

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

跳转百分比（1-100）

object (security_security_url_redirect_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "55",
  • "prio": 32,
  • "src_url": "192.168.1.253",
  • "dst_url": "192.168.3.169",
  • "mode": "exact",
  • "excluded": "",
  • "hit_rate": 100,
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

获取单个URL跳转策略

根据ID获取指定的URL跳转策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL跳转策略ID

Responses

Response samples

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

更新URL跳转策略

完整更新指定的URL跳转策略配置

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL跳转策略ID

Request Body schema: application/json
required

URL跳转策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

prio
required
integer [ 1 .. 63 ]

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

required
object (security_security_url_redirect_AddressObject)
src_url
required
string

源URL

dst_url
required
string

目的URL

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
required
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

跳转百分比（1-100）

required
object (security_security_url_redirect_TimeObject)
tagname
required
string

名称，支持中文、英文、数字、下划线和连字符，1-15个字符，不能以下划线或连字符开头；同时作为规则备注（comment），两者含义相同

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "prio": 32,
  • "src_addr": {
    },
  • "src_url": "192.168.1.253",
  • "dst_url": "192.168.3.169",
  • "mode": "exact",
  • "excluded": "",
  • "hit_rate": 100,
  • "time": {
    },
  • "tagname": "test1"
}

Response samples

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

启用/停用URL跳转策略

切换URL跳转策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL跳转策略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"
}

删除URL跳转策略

删除指定的URL跳转策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL跳转策略ID

Responses

Response samples

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

URL参数替换API

来源文件: security/security-url-replace.json

获取URL参数替换策略列表

获取URL参数替换策略列表，支持分页和过滤查询

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

页码（从1开始）

limit
integer >= 1
Default: 20

每页记录数

filter
string
Example: filter=enabled==yes&mode==exact

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

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

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

支持的字段：enabled、mode、param_keyword、rep_keyword、prio、hit_rate等 使用示例：

  • 单条件：filter=enabled==yes
  • AND条件：filter=enabled==yes&filter=mode==exact
  • OR条件：filter=param_keyword==test,filter=rep_keyword==replace
  • 优先级范围：filter=prio>=1&filter=prio<=63
  • 替换率过滤：filter=hit_rate>=75
  • 参数关键字：filter=param_keyword==query
order
string
Default: "prio"
Enum: "prio" "id"

排序字段（prio, id）

order_by
string
Default: "asc"
Enum: "asc" "desc"

排序方式（asc:升序, desc:降序）

Responses

Response samples

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

创建URL参数替换策略

创建新的URL参数替换策略，支持参数匹配和替换功能

Authorizations:
bearerAuth
Request Body schema: application/json
required

URL参数替换策略配置数据

prio
required
integer [ 1 .. 63 ]

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

enabled
required
string
Enum: "yes" "no"

规则状态

tagname
required
string

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

object (security_security_url_replace_AddressObject)
src_url
required
string

源URL

param_keyword
required
string

参数关键字

rep_keyword
required
string

替换值

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

替换百分比（1-100）

object (security_security_url_replace_TimeObject)

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "tagname": "test-rule",
  • "comment": "111",
  • "prio": 1,
  • "excluded": "",
  • "src_url": "192.168.1.253",
  • "mode": "exact",
  • "hit_rate": 100,
  • "rep_keyword": "aa",
  • "param_keyword": "query",
  • "src_addr": {
    },
  • "time": {
    }
}

Response samples

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

获取单个URL参数替换策略

根据ID获取指定的URL参数替换策略详情

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL参数替换策略ID

Responses

Response samples

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

更新URL参数替换策略

完整更新指定的URL参数替换策略配置。

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

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL参数替换策略ID

Request Body schema: application/json
required

URL参数替换策略更新数据

enabled
required
string
Enum: "yes" "no"

规则状态

prio
required
integer [ 1 .. 63 ]

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

required
object (security_security_url_replace_AddressObject)
src_url
required
string

源URL

param_keyword
required
string [ 1 .. 40 ] characters

参数关键字（1-40字符）

rep_keyword
required
string [ 1 .. 40 ] characters

替换值（1-40字符）

mode
required
string
Enum: "exact" "vague"

匹配模式

excluded
required
string

排除条件

hit_rate
required
integer [ 1 .. 100 ]

替换百分比（1-100）

required
object (security_security_url_replace_TimeObject)
tagname
required
string

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

Responses

Request samples

Content type
application/json
{
  • "enabled": "yes",
  • "prio": 1,
  • "src_addr": {
    },
  • "src_url": "192.168.1.253",
  • "param_keyword": "query",
  • "rep_keyword": "aa",
  • "mode": "exact",
  • "excluded": "",
  • "hit_rate": 100,
  • "time": {
    },
  • "tagname": "test1"
}

Response samples

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

启用/停用URL参数替换策略

切换URL参数替换策略的启用状态

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL参数替换策略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"
}

删除URL参数替换策略

删除指定的URL参数替换策略

Authorizations:
bearerAuth
path Parameters
id
required
integer >= 1

URL参数替换策略ID

Responses

Response samples

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