lss_management.md 16 KB

文档

LSS 节点管理

获取 LSS 节点列表(分页)

维护人:TG Live

URL

描述:获取 LSS 节点列表(分页)

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
page Integer - 页码 (从 1 开始) 1
size Integer - 每页条数 10
keyword String - 搜索关键词 (模糊匹配名称、ID 等) 摄像头
enabled Boolean - 启用状态过滤 (null=全部, true=启用, false=禁用) true
sortBy String - 排序字段 createdAt
sortDir String - 排序方向 (ASC/DESC) DESC

请求示例

{
    "page": 1,
    "size": 10,
    "keyword": "摄像头",
    "enabled": true,
    "sortBy": "createdAt",
    "sortDir": "DESC"
}

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "list": [
            {
                "id": 0,
                "lssId": "string",
                "lssName": "string",
                "machineId": "string",
                "address": "string",
                "maxTasks": 0,
                "currentTasks": 0,
                "status": "string",
                "ffmpegVersion": "string",
                "systemInfo": "string",
                "lastHeartbeatAt": "yyyy-MM-dd HH:mm:ss",
                "enabled": true,
                "loadRate": 0,
                "createdAt": "yyyy-MM-dd HH:mm:ss",
                "updatedAt": "yyyy-MM-dd HH:mm:ss"
            }
        ],
        "page": 1,
        "size": 10,
        "total": 100,
        "totalPages": 10,
        "hasNext": true,
        "hasPrevious": false
    }
}

错误码

获取全部 LSS 节点列表

维护人:TG Live

URL

描述:获取全部 LSS 节点列表

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: PageResponse)
└ list List 数据列表 (ActualType: T)
└ id Long - 数据库主键 0
└ lssId String - LSS 节点 ID
└ lssName String - LSS 节点名称
└ machineId String - 关联的机器 ID
└ address String - LSS 地址 (IP:Port)
└ maxTasks Integer - 最大并发任务数 0
└ currentTasks Integer - 当前任务数 0
└ status String - 节点状态: ONLINE, OFFLINE, BUSY, MAINTENANCE
└ ffmpegVersion String - FFmpeg 版本
└ systemInfo String - 系统信息 (JSON)
└ lastHeartbeatAt LocalDateTime - 最后心跳时间 yyyy-MM-dd HH:mm:ss
└ enabled Boolean - 是否启用 true
└ loadRate Double - 负载率 (0.0 - 1.0) 0.0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss
└ page Integer - 当前页码 (从 1 开始) 1
└ size Integer - 每页条数 10
└ total Long - 总记录数 100
└ totalPages Integer - 总页数 10
└ hasNext Boolean - 是否有下一页 true
└ hasPrevious Boolean - 是否有上一页 false
名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data array 响应数据 (ActualType: List)
└ id Long - 数据库主键 0
└ lssId String - LSS 节点 ID
└ lssName String - LSS 节点名称
└ machineId String - 关联的机器 ID
└ address String - LSS 地址 (IP:Port)
└ maxTasks Integer - 最大并发任务数 0
└ currentTasks Integer - 当前任务数 0
└ status String - 节点状态: ONLINE, OFFLINE, BUSY, MAINTENANCE
└ ffmpegVersion String - FFmpeg 版本
└ systemInfo String - 系统信息 (JSON)
└ lastHeartbeatAt LocalDateTime - 最后心跳时间 yyyy-MM-dd HH:mm:ss
└ enabled Boolean - 是否启用 true
└ loadRate Double - 负载率 (0.0 - 1.0) 0.0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 0,
            "lssId": "string",
            "lssName": "string",
            "machineId": "string",
            "address": "string",
            "maxTasks": 0,
            "currentTasks": 0,
            "status": "string",
            "ffmpegVersion": "string",
            "systemInfo": "string",
            "lastHeartbeatAt": "yyyy-MM-dd HH:mm:ss",
            "enabled": true,
            "loadRate": 0,
            "createdAt": "yyyy-MM-dd HH:mm:ss",
            "updatedAt": "yyyy-MM-dd HH:mm:ss"
        }
    ]
}

错误码

获取 LSS 节点详情

维护人:TG Live

URL

描述:获取 LSS 节点详情

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
lssId string - LSS 节点 ID

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: LssNodeDTO)
└ id Long - 数据库主键 0
└ lssId String - LSS 节点 ID
└ lssName String - LSS 节点名称
└ machineId String - 关联的机器 ID
└ address String - LSS 地址 (IP:Port)
└ maxTasks Integer - 最大并发任务数 0
└ currentTasks Integer - 当前任务数 0
└ status String - 节点状态: ONLINE, OFFLINE, BUSY, MAINTENANCE
└ ffmpegVersion String - FFmpeg 版本
└ systemInfo String - 系统信息 (JSON)
└ lastHeartbeatAt LocalDateTime - 最后心跳时间 yyyy-MM-dd HH:mm:ss
└ enabled Boolean - 是否启用 true
└ loadRate Double - 负载率 (0.0 - 1.0) 0.0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 0,
        "lssId": "string",
        "lssName": "string",
        "machineId": "string",
        "address": "string",
        "maxTasks": 0,
        "currentTasks": 0,
        "status": "string",
        "ffmpegVersion": "string",
        "systemInfo": "string",
        "lastHeartbeatAt": "yyyy-MM-dd HH:mm:ss",
        "enabled": true,
        "loadRate": 0,
        "createdAt": "yyyy-MM-dd HH:mm:ss",
        "updatedAt": "yyyy-MM-dd HH:mm:ss"
    }
}

错误码

根据机器 ID 获取关联的 LSS 节点

维护人:TG Live

URL

描述:根据机器 ID 获取关联的 LSS 节点

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
machineId string - 机器 ID

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data array 响应数据 (ActualType: List)
└ id Long - 数据库主键 0
└ lssId String - LSS 节点 ID
└ lssName String - LSS 节点名称
└ machineId String - 关联的机器 ID
└ address String - LSS 地址 (IP:Port)
└ maxTasks Integer - 最大并发任务数 0
└ currentTasks Integer - 当前任务数 0
└ status String - 节点状态: ONLINE, OFFLINE, BUSY, MAINTENANCE
└ ffmpegVersion String - FFmpeg 版本
└ systemInfo String - 系统信息 (JSON)
└ lastHeartbeatAt LocalDateTime - 最后心跳时间 yyyy-MM-dd HH:mm:ss
└ enabled Boolean - 是否启用 true
└ loadRate Double - 负载率 (0.0 - 1.0) 0.0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 0,
            "lssId": "string",
            "lssName": "string",
            "machineId": "string",
            "address": "string",
            "maxTasks": 0,
            "currentTasks": 0,
            "status": "string",
            "ffmpegVersion": "string",
            "systemInfo": "string",
            "lastHeartbeatAt": "yyyy-MM-dd HH:mm:ss",
            "enabled": true,
            "loadRate": 0,
            "createdAt": "yyyy-MM-dd HH:mm:ss",
            "updatedAt": "yyyy-MM-dd HH:mm:ss"
        }
    ]
}

错误码

启用/禁用 LSS 节点

维护人:TG Live

URL

描述:启用/禁用 LSS 节点

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
lssId string - LSS 节点 ID
enabled boolean - 是否启用 true

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object - 响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码

删除 LSS 节点

维护人:TG Live

URL

描述:删除 LSS 节点

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
lssId string - LSS 节点 ID

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object - 响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码

获取 LSS 节点统计信息

维护人:TG Live

URL

描述:获取 LSS 节点统计信息

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: LssNodeStats)
└ total long - No comments found. 0
└ online long - No comments found. 0
└ offline long - No comments found. 0
└ busy long - No comments found. 0
└ maintenance long - No comments found. 0

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "total": 0,
        "online": 0,
        "offline": 0,
        "busy": 0,
        "maintenance": 0
    }
}

错误码