1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。

查询NVR设备本地录像文件列表。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeLocalRecords	操作接口名，系统规定参数。
InProtocol	String	是	ehome	使用的接入协议。取值: ehome
RecType	Int	是	0xff	录像类型：0xff-全部类型，0-定时录像，1-移动报警，2-报警触发，3-报警\|动测，4-报警&动测，5-命令触发，6-手动录像，7-震动报警，8-环境报警，9-智能报警（或者取证录像），10（0x0a）-PIR报警，11（0x0b）-无线报警，12（0x0c）-呼救报警，13（0x0d）-全部报警
ChannelNum	Int	是	1	通道的ID 1,2,3....
DeviceId	String	是	32388487739092995	设备ID。
StartTime	Long	否	1571639499	开始时间，默认为当天0点。 unix时间戳，单位秒。
EndTime	Long	否	1571641299	结束时间，默认为当前时间。 unix时间戳，单位秒。

3. 返回参数

参数	类型	描述
DeviceId	String	设备ID。
LocalRecords	LocalRecord[]	本地录像文件列表。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

LocalRecord

参数	类型	描述
FileName	String	录像文件名
FileSize	Long	文件大小 BYTE
FileMainType	Int	文件主类型：0xff-全部类型，0-定时录像，1-移动报警，2-报警触发，3-报警\|动测，4-报警&动测，5-命令触发，6-手动录像，7-震动报警，8-环境报警，9-智能报警（或者取证录像），10（0x0a）-PIR报警，11（0x0b）-无线报警，12（0x0c）-呼救报警，13（0x0d）-全部报警
FileSubType	Int	0-不是取证录像类型，1-超车，2-占道，3-停车，4-逆行，5-倒车，6-掉头，7-变道，8-压线，9-其他，主类型（dwFileMainType）为9并且为取证录像时有效
StartTime	Long	录像开始时间，UTC
EndTime	Long	录像结束时间，UTC

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=DescribeLocalRecords
&InProtocol=gb28181
&DeviceId=32388487739092995
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=b5Gv5U2hlTHgeEaKE9KgVoo6DWw%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1578406
&SignatureVersion=1.0
&Timestamp=1599113545

4.2 返回示例

{
  "DeviceId": "32388487739092995",
  "LocalRecords": [
    {
      "StartTime": 1571639499,
      "EndTime": 1571641298,
      "Duration": 1800,
    },
    {
      "StartTime": 1571641299,
      "EndTime": 1571643098,
      "Duration": 1800,
    }
  ],
  "RequestId": "3247575e6e1044668962f5a464fa3885"
}

5. 错误码

ErrorCode	ErrorMessage

查询本地录像文件列表

最近更新时间：2025-02-21 02:50:53

1. 接口描述

2. 请求参数

3. 返回参数

LocalRecord

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码