获取IVS录像列表（IVS1800/IVS3800）（API名称：getRecordList）
功能介绍
获取视频播放URL接口时需要用到的接口。
相关接口
|
接口名称 |
调用说明 |
|---|---|
|
调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。 |
URL
|
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
|---|---|---|---|
|
POST |
https://isdp+域名/openapi/v1/ivs/getRecordList |
OpenAPI |
application/json |
请求头
|
KEY |
VALUE |
是否必填 |
描述 |
|---|---|---|---|
|
Content-Type |
application/json |
是 |
无 |
|
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
|
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
|
deviceId |
String |
是 |
设备Id |
|
startTime |
String |
否 |
开始时间，格式 ：YYYYMMDDHHmmss 例：20220602111111 |
|
endTime |
String |
是 |
结束时间，YYYYMMDDHHmmss 例：20220604111111 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
resultCode |
Int |
响应编码 |
|
recordInfos |
Object |
录像查询结果分页信息参见类型RecordInfos |
RecordInfos出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
total |
int |
总记录数 |
|
indexRange |
IndexRange |
分页信息 |
|
reserve |
string |
保留字段长度限制32字节，必须保留该字段，字段内容可以置空 |
|
recordInfoList |
RecordInfoList |
录像信息列表 |
IndexRange出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
fromIndex |
Integer |
开始索引正整数，取值范围为1~1000 |
|
toIndex |
Integer |
结束索引正整数，取值范围为1~1000，且结束索引必须大于或者等于开始索引 |
RecordInfoList出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
recordInfo |
RecordInfo |
录像信息 |
RecordInfo出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
recordFileName |
string |
录像文件名由汉字和字母（a-z和A-Z）、数字、中划线和下划线组成，长度限制256字节 |
|
recordMethod |
int |
录像方式：● 0：平台录像● 1：前端录像● 2：备份服务器● 3：容灾录像 |
|
nvrCode |
string |
NVR编码查询平台录像时，该字段有值。例如：9145a3f7c4164d3ab9e161fcb4221426，长度限制32字节 |
|
mbuDomain |
string |
备份服务器域编码查询备份录像时，该字段有值。例如：6bdacabae9c546e9ab5b8688ccd85a59，长度限制32字节 |
|
recordType |
int |
录像类型：● 100：手动录像● 010：计划录像● 001：告警录像 说明：录像类型可叠加，如：110标识查询手动录像和计划录像。 |
|
alarmType |
string |
告警类型，长度限制64字节 |
|
recordTime |
TimeSpan |
录像起止时间 |
|
frameExtractionTimes |
int |
录像抽帧次数：● 0：完整● 1：不完整（抽帧一次）● 2：不完整（抽帧二次）● 3：不完整（抽帧三次） |
|
bookmarkInfo |
BookmarkInfo |
录像标签信息（查询方式为按书签时有效） |
|
lockInfo |
LockInfo |
录像锁定信息（查询方式为按锁定信息时有效） |
|
ptzPresetInfo |
PTZPresetInfo |
录像预置位信息（查询方式为按预置位查询时有效） |
|
reserve |
string |
保留字段长度限制64字节，必须保留该字段，字段内容可以置空 |
TimeSpan出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
startTime |
string |
开始时间格式如yyyyMMddHHmmss，例如：20121207102035，长度限制20字节 |
|
endTime |
string |
结束时间格式如yyyyMMddHHmmss，例如：20121207202035，长度限制20字节 |
BookmarkInfo出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
bookmarkId |
int |
录像标签ID |
|
bookmarkName |
string |
录像标签名称由汉字和字母（a-z和A-Z）、数字、中划线和下划线组成，长度限制612字节 |
|
bookmarkTime |
string |
标签时间时间格式为yyyyMMddHHmmss，例如：20121207102035，长度限制20字节 |
|
cameraCode |
string |
摄像机编码例如：32010300100201030101#6bdacabae9c546e9ab5b8688ccd85a59，长度限制64字节 |
|
cameraName |
string |
摄像机名称键盘可见字符和中文，长度限制128字节 |
|
userDomain |
string |
添加该录像标签的用户所在域编码例如：6bdacabae9c546e9ab5b8688ccd85a59，长度限制32字节 |
|
bookmarkCreatorId |
int |
添加该录像标签的用户ID |
|
bookmarkCreatorName |
string |
添加该录像标签的用户名键盘可见字符和中文，长度限制128字节 |
|
nvrCode |
string |
NVR编码查询平台录像的标签时，该字段有值例如：9145a3f7c4164d3ab9e161fcb4221426，长度限制32字节 |
|
mbuDomain |
string |
备份服务器域编码查询备份录像的标签时，该字段有值例如：6bdacabae9c546e9ab5b8688ccd85a59，长度限制32字节 |
|
reserve |
string |
保留字段长度限制32字节，必须保留该字段，字段内容可以置空 |
LockInfo出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
lockId |
int |
录像锁定ID |
|
lockTime |
string |
执行锁定操作的时间时间格式为yyyyMMddHHmmss，例如：20121207102035，长度限制20字节 |
|
lockTimeSpan |
TimeSpan |
被锁定的录像的时间段 |
|
lockDesc |
string |
录像锁定描述键盘可见字符和中文，长度限制260字节 |
|
operatorId |
int |
执行该录像锁定操作的用户ID |
|
operatorName |
string |
执行该录像锁定操作的用户名键盘可见字符和中文，长度限制128字节 |
|
reserve |
string |
保留字段长度限制64字节，必须保留该字段，字段内容可以置空 |
PTZPresetInfo出参：
|
参数 |
类型 |
描述 |
|---|---|---|
|
presetIndex |
int |
预置位索引号 |
|
presetName |
string |
预置位名称由汉字和字母（a-z和A-Z）、数字、中划线和下划线组成，长度限制32字节 |
|
reserve |
string |
保留字段长度限制32字节，必须保留该字段，字段内容可以置空注：调用修改预置位接口时，请求中不添加该字段 |
|
focusSwitch |
int |
可以为空，或者null，如果为空，默认不启用对焦记忆开关 0-不启用，1-启用 |
请求示例
{
"deviceId" : "05238798089631890101#9acedeced6794b468330d3c15ecb36b3",
"startTime" : "20220601121212",
"endTime" : "20220614121212"
}
响应示例
{
"status": 1,
"message": "SUCCESS",
"error": null,
"data":{
"resultCode": 0,
"recordInfos":{
"total": 0,
"indexRange":{
"fromIndex": 1,
"toIndex": 1000
},
"reserve": "",
"recordInfoList":{
"recordInfo":[
]
}
}
},
"timestamp": "2022-06-20T19:44:47.230+0800"
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
