开发者平台

TP-LINK官网首页
开发者平台 / 视频管理系统(VMS)/API功能接口定义/录像配置

4.5 录像配置

4.5.1 获取录像配置

接口说明:

名称 内容

URL

https://xxx/tums/record/v1/getRecordCfgs

功能说明

获取录像配置

使用限制

用户仅能获取到自己关联的项目下的设备的录像配置。

请求参数:

参数名称

参数描述

start

Long

搜索开始的位置,范围不小于0

limit

Integer

范围1~20

filterAnd

Map

与条件

必要参数

“projectId” (String)、“regionId” (int)

可选参数,默认支持精确搜索

“ipFloor” (String) IP地址下界,格式“X.X.X.X”

“ipCeiling” (String) IP地址上界,格式“X.X.X.X”

“streamType” (int) 码流类型,0表示主码流、1表示子码流。

“devName” (String) 监控点名称,支持模糊搜索

“recordPlanId” (int) 录像计划ID

“recordSwitch” (int) 录像开关,0表示关闭,1表示开启

“storageType” (int) 录像存储设备类型,默认值为1(NVR)

“storageDevId” (String) 录像存储位置

“storageType”和“storageDevId”可定位数据库中的一个存储设备

filterOr

Map

或条件

sort

List

排序方式(”IP 监控点设备的IP地址)

示例: [{ip: "desc"}]

返回参数:

参数名称

参数描述

error_code

返回码,0 – 成功,其他- 失败,具体请参考返回码章节

result

total

int

返回录像配置的数量

list

List

devId

String

设备在设备信息表中的索引

devName

String

设备名称

parentId

String

监控点所属NVR在设备信息表的索引

直连IPC该值为0

ip 

String

IP地址

(192.168.1.1的格式)

storageNum

int

存储设备数量

取值范围为[1,3]

devStorageType

int

监控点的设备类型

0表示高速球机

2表示云台IPC

-1表示不支持存储的其他IPC设备

实际为存储设备类型,但取值范围局限于IPC

expand

List

id

int

录像配置在数据表中的索引

isParent

int

存储设备是否为监控点所属NVR

0表示否,1表示是

recordSwitch

int

录像开关

0表示关闭,1表示开启

streamType

int

录像的码流类型

0表示主码流、1表示子码流。

recordPlanId

int

选择的录像计划索引

recordPlanName

String

选择的录像计划名称

storageType

int

录像存储设备类型,默认值为1(NVR)

具体对应的类型码可见下表

storageDevId

String

存储设备的ID,有以下取值:

自身支持存储的IPC和NVR的ID,或者存储服务器的ID,因此不同存储设备该值可能重复,因此需要storageType字段

storageDevName 
String

存储设备名称

redirectSwitch

String

流媒体转发开关

motionDetectWarning

int

移动侦测生效标识

示例:

https://xxx/tums/record/v1/getRecordCfgs

request: {
    "start": 0,
    "limit": 10,
    "filterAnd": {
        "projectId": "1",
        "regionId": 4
    },
    "filterOr": {},
    "sort": []
}

response: {
    "error_code": 0,
    "result": {
        "total": 1,
        "list": [
            {
                "devId": "2",
                "devName": "test-device-001",
                "parentId": "1",
                "ip": "127.0.31.2",
                "storageNum": 1,
                "devStorageType": -1,
                "expand": [
                    {
                        "id": 4,
                        "isParent": 1,
                        "recordSwitch": 1,
                        "streamType": 0,
                        "recordPlanId": 1,
                        "recordPlanName": "全天候模板",
                        "storageType": 1,
                        "storageDevId": "1",
                        "storageDevName":"TL-NVR6400 1.0",
                        "redirectSwitch":1,
                        "motionDetectWarning":1 
                    }
                ]
            }
        ]
    }
}