API接口介绍及使用说明

使用说明

API密钥获取

API密钥获取请前往【角色管理】【管理员及API】页面，显示管理员对应的API密钥列。

管理员所在权限分组，需具备对应接口的请求授权才可使用，请注意提前分配好需要的权限。

API密钥获取

接口使用

所有接口使用form-data接收您提交的数据，使用json返回请求结果。

其中api_key为接口密钥，必须提交。接口有提交频率限制，请勿高频调用。

复数形式参数支持多数据传入，使用英文逗号间隔，如lists，可以使用 "114.114.114.114,223.5.5.5,119.29.29.29"同时传入多个ip规则。

网络安全

安全组接口

安全组查询接口

用途：获取安全组信息

路径：https://rosz.cn/api/sec/group_info

参数：

api_key：请求密钥

groups：查询的安全组名称，支持同时多个数据传入；为空时返回所有信息

names：查询的安全组别名，支持同时多个数据传入；为空时返回所有信息

comment：查询的安全组备注

返回示例：

{
    "code": 0,
    "msg": "ok",
    "count": 2,
    "data": [
        {
            "group": "test2",
            "name": "别名1",
            "comment": "备注1",
            "created_at": "2023-05-01 09:16:14"
        },
        {
            "group": "test",
            "name": "别名2",
            "comment": "备注2",
            "device_ids": "4252",
            "created_at": "2023-04-30 00:18:07"
        }
    ]
}

安全规则查询接口

用途：获取安全组规则信息

路径：https://rosz.cn/api/sec/list_info

参数：

api_key：请求密钥

groups：查询的安全组名称，支持同时多个数据传入；为空时返回所有信息

lists：查询的安全组规则信息，支持同时多个数据传入；为空时返回所有信息

comment：查询的安全规则备注

expire：安全规则到期时间

返回示例：

{
    "code": 0,
    "msg": "ok",
    "count": 1,
    "data": [
        {
            "group": "test",
            "lists": "baidu.com",
            "range": 16,
            "created_at": "2023-04-30 00:42:13",
            "expire": "2099-12-31 23:59:59"
        }
    ]
}

新增安全规则接口

用途：新增安全规则

路径：https://rosz.cn/api/sec/list_add

参数：

api_key：请求密钥

groups：关联的安全组名称，支持同时多个数据传入；不可为空

lists：安全规则信息，IP或者域名，也可以为CIDR格式IP段，支持同时多个数据传入；不可为空

range：包容度，仅对域名规则有效，范围1-65536，不可为空，如使用256代表间隔256个ip以内的作为连续IP规则使用，建议16；不可为空

comment：安全规则备注；可为空

expire：安全规则到期时间，格式为“2024-09-05 14:01:27”；为空则设置为永久有效

返回示例：

{
    "code": 0,
    "data": {},
    "msg": "成功添加6条IP规则！"
}

安全规则删除接口

用途：删除安全组规则

路径：https://rosz.cn/api/sec/list_del

参数：

api_key：请求密钥

groups：删除的安全组名称，支持同时多个数据传入；不可为空

lists：删除的安全组规则信息，支持同时多个数据传入；不可为空

返回示例：

{
    "code": 0,
    "data": {},
    "msg": "安全组规则删除完成！"
}