camera_manage.md 26 KB

文档

摄像头管理

获取摄像头列表(分页)

维护人:TG Live

URL

描述:获取摄像头列表(分页)

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
lssId String - LSS 节点 ID 过滤 lss_001
status String - 在线状态过滤 (ONLINE/OFFLINE) ONLINE

请求示例

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

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "list": [
            {
                "id": 1,
                "cameraId": "cam_001",
                "name": "主摄像头",
                "ip": "192.168.1.100",
                "port": 80,
                "username": "admin",
                "brand": "hikvision",
                "capability": "ptz_enabled",
                "status": "ONLINE",
                "lssId": "lss_001",
                "model": "DS-2CD2T47G2-LSU/SL",
                "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
                "channelNo": "1",
                "remark": "string",
                "enabled": true,
                "createdAt": "2026-01-07T10:00:00",
                "updatedAt": "2026-01-07T10:00:00"
            }
        ],
        "page": 1,
        "size": 10,
        "total": 100,
        "totalPages": 10,
        "hasNext": true,
        "hasPrevious": false
    }
}

错误码

获取摄像头列表(全部,不分页)

维护人:TG Live

URL

描述:获取摄像头列表(全部,不分页)

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: PageResponse)
└ list List 数据列表 (ActualType: T)
└ id Long - 主键 ID 1
└ cameraId String - 摄像头 ID cam_001
└ name String - 名称 主摄像头
└ ip String - IP 地址 192.168.1.100
└ port Integer - 端口 80
└ username String - 用户名 admin
└ brand String - 品牌 hikvision
└ capability String - 能力: switch_only, ptz_enabled ptz_enabled
└ status String - 状态: ONLINE, OFFLINE ONLINE
└ lssId String - 绑定的 LSS 节点 ID lss_001
└ model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
└ rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
└ channelNo String - 通道号 1
└ remark String - 备注
└ enabled Boolean - 是否启用 true
└ createdAt LocalDateTime - 创建时间 2026-01-07T10:00:00
└ updatedAt LocalDateTime - 更新时间 2026-01-07T10:00:00
└ page Integer - 当前页码 (从 1 开始) 1
└ size Integer - 每页条数 10
└ total Long - 总记录数 100
└ totalPages Integer - 总页数 10
└ hasNext Boolean - 是否有下一页 true
└ hasPrevious Boolean - 是否有上一页 false
名称 类型 必填 最大长度 描述 示例值
machineId string - 机器 ID(可选) machine_001

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data array 响应数据 (ActualType: List)
└ id Long - 主键 ID 1
└ cameraId String - 摄像头 ID cam_001
└ name String - 名称 主摄像头
└ ip String - IP 地址 192.168.1.100
└ port Integer - 端口 80
└ username String - 用户名 admin
└ brand String - 品牌 hikvision
└ capability String - 能力: switch_only, ptz_enabled ptz_enabled
└ status String - 状态: ONLINE, OFFLINE ONLINE
└ lssId String - 绑定的 LSS 节点 ID lss_001
└ model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
└ rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
└ channelNo String - 通道号 1
└ remark String - 备注
└ enabled Boolean - 是否启用 true
└ createdAt LocalDateTime - 创建时间 2026-01-07T10:00:00
└ updatedAt LocalDateTime - 更新时间 2026-01-07T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 1,
            "cameraId": "cam_001",
            "name": "主摄像头",
            "ip": "192.168.1.100",
            "port": 80,
            "username": "admin",
            "brand": "hikvision",
            "capability": "ptz_enabled",
            "status": "ONLINE",
            "lssId": "lss_001",
            "model": "DS-2CD2T47G2-LSU/SL",
            "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
            "channelNo": "1",
            "remark": "string",
            "enabled": true,
            "createdAt": "2026-01-07T10:00:00",
            "updatedAt": "2026-01-07T10:00:00"
        }
    ]
}

错误码

获取摄像头详情

维护人:TG Live

URL

描述:获取摄像头详情

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraInfoDTO)
└ id Long - 主键 ID 1
└ cameraId String - 摄像头 ID cam_001
└ name String - 名称 主摄像头
└ ip String - IP 地址 192.168.1.100
└ port Integer - 端口 80
└ username String - 用户名 admin
└ brand String - 品牌 hikvision
└ capability String - 能力: switch_only, ptz_enabled ptz_enabled
└ status String - 状态: ONLINE, OFFLINE ONLINE
└ lssId String - 绑定的 LSS 节点 ID lss_001
└ model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
└ rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
└ channelNo String - 通道号 1
└ remark String - 备注
└ enabled Boolean - 是否启用 true
└ createdAt LocalDateTime - 创建时间 2026-01-07T10:00:00
└ updatedAt LocalDateTime - 更新时间 2026-01-07T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "cameraId": "cam_001",
        "name": "主摄像头",
        "ip": "192.168.1.100",
        "port": 80,
        "username": "admin",
        "brand": "hikvision",
        "capability": "ptz_enabled",
        "status": "ONLINE",
        "lssId": "lss_001",
        "model": "DS-2CD2T47G2-LSU/SL",
        "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
        "channelNo": "1",
        "remark": "string",
        "enabled": true,
        "createdAt": "2026-01-07T10:00:00",
        "updatedAt": "2026-01-07T10:00:00"
    }
}

错误码

添加摄像头

维护人:TG Live

URL

描述:添加摄像头

ContentType:application/json

请求参数

Body Parameter

| 名称 | 类型 | 必填 | 最大长度 | 描述 | 示例值 | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | cameraId | String | 是 | 50 | 摄像头 ID(唯一标识)
Validate[max: 50; ] | cam_001 | | name | String | 是 | 100 | 名称
Validate[max: 100; ] | 主摄像头 | | ip | String | 是 | - | IP 地址
Validate[regexp: ^((25[0-5] | 2[0-4]\d | [01]?\d\d?)\.){3}(25[0-5] | 2[0-4]\d | [01]?\d\d?)$; ] | 192.168.1.100 | | port | Integer | 否 | - | 端口 | 80 | | username | String | 否 | 50 | 用户名
Validate[max: 50; ] | admin | | password | String | 否 | 100 | 密码
Validate[max: 100; ] | password123 | | brand | String | 否 | 30 | 品牌
Validate[max: 30; ] | hikvision | | capability | String | 否 | - | 能力: switch_only, ptz_enabled
Validate[regexp: ^(switch_only | ptz_enabled)$; ] | ptz_enabled | | lssId | String | 否 | - | 绑定的 LSS 节点 ID | lss_001 | | model | String | 否 | 100 | 摄像头型号
Validate[max: 100; ] | DS-2CD2T47G2-LSU/SL | | rtspUrl | String | 否 | 500 | RTSP 推流地址
Validate[max: 500; ] | rtsp://admin:password@192.168.1.100:554/stream1 | | channelNo | String | 否 | 20 | 通道号 (用于多通道摄像头)
Validate[max: 20; ] | 1 | | remark | String | 否 | 500 | 备注
Validate[max: 500; ] | |

请求示例

{
    "cameraId": "cam_001",
    "name": "主摄像头",
    "ip": "192.168.1.100",
    "port": 80,
    "username": "admin",
    "password": "password123",
    "brand": "hikvision",
    "capability": "ptz_enabled",
    "lssId": "lss_001",
    "model": "DS-2CD2T47G2-LSU/SL",
    "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
    "channelNo": "1",
    "remark": "string"
}

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraInfoDTO)
└ id Long - 主键 ID 1
└ cameraId String - 摄像头 ID cam_001
└ name String - 名称 主摄像头
└ ip String - IP 地址 192.168.1.100
└ port Integer - 端口 80
└ username String - 用户名 admin
└ brand String - 品牌 hikvision
└ capability String - 能力: switch_only, ptz_enabled ptz_enabled
└ status String - 状态: ONLINE, OFFLINE ONLINE
└ lssId String - 绑定的 LSS 节点 ID lss_001
└ model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
└ rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
└ channelNo String - 通道号 1
└ remark String - 备注
└ enabled Boolean - 是否启用 true
└ createdAt LocalDateTime - 创建时间 2026-01-07T10:00:00
└ updatedAt LocalDateTime - 更新时间 2026-01-07T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "cameraId": "cam_001",
        "name": "主摄像头",
        "ip": "192.168.1.100",
        "port": 80,
        "username": "admin",
        "brand": "hikvision",
        "capability": "ptz_enabled",
        "status": "ONLINE",
        "lssId": "lss_001",
        "model": "DS-2CD2T47G2-LSU/SL",
        "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
        "channelNo": "1",
        "remark": "string",
        "enabled": true,
        "createdAt": "2026-01-07T10:00:00",
        "updatedAt": "2026-01-07T10:00:00"
    }
}

错误码

更新摄像头

维护人:TG Live

URL

描述:更新摄像头

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
id Long - 摄像头数据库 ID 1
name String - 名称 主摄像头
ip String - IP 地址 192.168.1.100
port Integer - 端口 80
username String - 用户名 admin
password String - 密码(不传或为空则不修改) password123
brand String - 品牌 hikvision
capability String - 能力: switch_only, ptz_enabled ptz_enabled
lssId String - 绑定的 LSS 节点 ID lss_001
model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
channelNo String - 通道号 1
remark String - 备注
enabled Boolean - 启用状态 true

请求示例

{
    "id": 1,
    "name": "主摄像头",
    "ip": "192.168.1.100",
    "port": 80,
    "username": "admin",
    "password": "password123",
    "brand": "hikvision",
    "capability": "ptz_enabled",
    "lssId": "lss_001",
    "model": "DS-2CD2T47G2-LSU/SL",
    "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
    "channelNo": "1",
    "remark": "string",
    "enabled": true
}

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraInfoDTO)
└ id Long - 主键 ID 1
└ cameraId String - 摄像头 ID cam_001
└ name String - 名称 主摄像头
└ ip String - IP 地址 192.168.1.100
└ port Integer - 端口 80
└ username String - 用户名 admin
└ brand String - 品牌 hikvision
└ capability String - 能力: switch_only, ptz_enabled ptz_enabled
└ status String - 状态: ONLINE, OFFLINE ONLINE
└ lssId String - 绑定的 LSS 节点 ID lss_001
└ model String - 摄像头型号 DS-2CD2T47G2-LSU/SL
└ rtspUrl String - RTSP 推流地址 rtsp://admin:password@192.168.1.100:554/stream1
└ channelNo String - 通道号 1
└ remark String - 备注
└ enabled Boolean - 是否启用 true
└ createdAt LocalDateTime - 创建时间 2026-01-07T10:00:00
└ updatedAt LocalDateTime - 更新时间 2026-01-07T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "cameraId": "cam_001",
        "name": "主摄像头",
        "ip": "192.168.1.100",
        "port": 80,
        "username": "admin",
        "brand": "hikvision",
        "capability": "ptz_enabled",
        "status": "ONLINE",
        "lssId": "lss_001",
        "model": "DS-2CD2T47G2-LSU/SL",
        "rtspUrl": "rtsp://admin:password@192.168.1.100:554/stream1",
        "channelNo": "1",
        "remark": "string",
        "enabled": true,
        "createdAt": "2026-01-07T10:00:00",
        "updatedAt": "2026-01-07T10:00:00"
    }
}

错误码

删除摄像头

维护人:TG Live

URL

描述:删除摄像头

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1

响应参数

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

响应示例

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

错误码

检测摄像头连通性

维护人:TG Live

URL

描述:检测摄像头连通性

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1

响应参数

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

响应示例

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

错误码

获取摄像头快照

维护人:TG Live

URL

描述:获取摄像头快照

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1

响应参数

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

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            " -": ""
        }
    ]
}

错误码

PTZ 控制

维护人:TG Live

URL

描述:PTZ 控制

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
id Long - 摄像头 ID 1
action String - PTZ 动作 UP
speed Float - 速度 (0.0 - 1.0) 0.5

请求示例

{
    "id": 1,
    "action": "UP",
    "speed": 0.5
}

响应参数

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

响应示例

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

错误码

获取摄像头预置位列表

维护人:TG Live

URL

描述:获取摄像头预置位列表

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1
channel int32 - 通道号(可选) 1

响应参数

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

响应示例

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

错误码

获取摄像头设备信息

维护人:TG Live

URL

描述:获取摄像头设备信息

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

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - 摄像头主键 ID 1

响应参数

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

响应示例

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

错误码