1. 接口描述

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

查询录制文件列表，PlayUrl可用于点播该文件。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeRecords	操作接口名，系统规定参数。
DeviceId	String	是	1001	根据DeviceID查询。
StartTime	String	是	2020-08-10 00:00:00	根据开始时间查询。大于等于开始时间；格式为yyyy-mm-dd HH:MM:SS
EndTime	String	是	2020-08-11 00:00:00	根据结束时间查询。小于结束时间；格式为yyyy-mm-dd HH:MM:SS
RecordType	Long	否	0	录制文件类型，0-云端，1-本地
Sign	String	否	true	是否对请求地址进行签名，true-签名 false-不签名
SortBy	String	否	StartTime	选择按一个字段排序，可选值为： - StartTime 默认为StartTime，按照开始时间排序。
SortDirection	String	否	asc	排序方式，默认升序。取值：asc(升序), desc(降序)。
PageNum	Long	否	1	第几个分页，默认为1。
PageSize	Long	否	20	分页大小，默认为20。取值范围为1～1000
InProtocol	String	是	gb28181	使用的接入协议，默认gb28181。取值: gb28181, rtmp, rtsp, onvif, ehome, vgroup
RecType	Long	否	1	录制类型，适用于ehome协议
ChannelNum	Long	否	123	通道号，适用于ehome协议
RealGroupId	String	否	123	真实组ID，适用于vgroup

3. 返回参数

参数	类型	描述
PageNum	Long	第几个分页。
PageSize	Long	分页大小。
TotalPage	Long	分页总数。
TotalNum	Long	录制文件总数。
Records	Record[]	录制文件列表。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

Record

参数	类型	描述
FileFormat	String	录制文件格式，多值用逗号分隔。取值: hls, flv, mp4
Video	Video{}	视频流属性信息。
PlayUrl	PlayUrl{}	录制文件点播Url。
StartTime	String	录制文件开始时间。
EndTime	String	录制文件结束时间。
Duration	Long	录制文件时长，单位秒。
Cover	String	录制文件封面。

Video

参数	类型	描述
Codec	String	取值: h264, h265

PlayUrl

参数	类型	描述
RtmpUrl	String	rtmp播放url
FlvUrl	String	flv播放url
HlsUrl	String	hls播放url

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=DescribeRecords
&DeviceId=29942058487644187
&StartTime=2020-09-03+00%3A00%3A00
&EndTime=2020-09-04+00%3A00%3A00
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=XfKaZRa13%2BDs44DeB8yDqZR45UM%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=188297423
&SignatureVersion=1.0
&Timestamp=1599104648

4.2 返回示例

{
  "PageNum": 1,
  "PageSize": 20,
  "TotalPage": 1,
  "TotalNum": 7,
  "Records": [
    {
      "FileFormat": "hls",
      "Video": {
        "Codec": "h264"
      },
      "PlayUrl": {
        "HlsUrl": "http://127.0.0.1:7480/record-rh/record/hls/group/29942058487644187/2020-09-03-08-58-09/playlist1599104657_signed.m3u8?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=c8x8v3YdlxxxxxTVD8lU%2F20200903%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20200903T034418Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=570ebe506c201f9c5d188713ff4ef293ec61bf38b5e7076f36844d8c4a08d1b8",
        "FlvUrl": "",
        "Mp4Url": ""
      },
      "StartTime": "2020-09-03 08:58:09",
      "EndTime": "2020-09-03 09:28:09",
      "Duration": 1800,
      "RequestId": "",
      "DownloadUrl": ""
    },
    {
      "FileFormat": "hls",
      "Video": {
        "Codec": "h264"
      },
      "PlayUrl": {
        "RtmpUrl": "http://127.0.0.1:7480/record-rh/record/rtmpurl/rwwqrwer222222/",
        "HlsUrl": "http://127.0.0.1:7480/record-rh/record/hls/group/29942058487644187/2020-09-03-09-28-09/playlist1599104657_signed.m3u8?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=c8x8v3YdlxxxxxTVD8lU%2F20200903%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20200903T034418Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=4acc723ec7f4df3e32763b92ce2fe1f84589c9643ba9147f7811cb31cd7ceff7",
        "FlvUrl": "http://127.0.0.1:7480/record-rh/record/flvurl/f38f3fji/"
        
      },
      "StartTime": "2020-09-03 09:28:09",
      "EndTime": "2020-09-03 09:58:10",
      "Duration": 1801,
      "Cover": "page001-zza",
    }
  ],
  "RequestId": "5ce6e70103924612888a04a23b9dd670"
}

5. 错误码

ErrorCode	ErrorMessage

查询录制文件列表

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

1. 接口描述

2. 请求参数

3. 返回参数

Record

Video

PlayUrl

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码