1. 接口描述

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

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeRecord	操作接口名，系统规定参数。
DeviceId	String	是	1001	设备ID。
FileFormat	String	是	hls	录制文件格式。取值: hls
StartTime	String	是	2020-08-10 00:00:00	录制文件开始时间。格式为yyyy-mm-dd HH:MM:SS
EndTime	String	是	2020-08-10 01:00:00	录制文件结束时间。格式为yyyy-mm-dd HH:MM:SS EndTime-StartTime不超过2小时
Trans	String	否	true	是否进行转码，true或者false
InProtocol	String	是	gb28181	使用的接入协议，默认gb28181。取值: gb28181, rtmp, rtsp, onvif, ehome, vgroup
RealGroupId	String	否	123	真实组ID，适用于vgroup

3. 返回参数

参数	类型	描述
Video	Video{}	视频流属性信息。
PlayUrl	PlayUrl{}	录制文件点播Url。
DownloadUrl	String	录制文件下载Url。
StartTime	String	录制文件开始时间。
EndTime	String	录制文件结束时间。
Duration	Long	录制文件时长，单位秒。
FileFormat	String	录制文件格式。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

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=DescribeRecord
&DeviceId=29942058487644187
&EndTime=2020-09-03+12%3A40%3A00
&FileFormat=hls
&InProtocol=gb28181
&StartTime=2020-09-03+12%3A30%3A00
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=20oqZmF70F2MjV%2BWIvl1YLcSyus%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1168584718
&SignatureVersion=1.0
&Timestamp=1599114148

4.2 返回示例

{
  "Video": {
    "Codec": "h264"
  },
  "PlayUrl": {
    "HlsUrl": "http://127.0.0.1:7480/record-rh/record/hls/device/29942058487644187/2020-09-03-12-30-00/playlist1599114157_signed.m3u8?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=c8x8v3YdlxxxxxTVD8lU%2F20200903%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20200903T062237Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=9baaf781b079dde8bc57465390808f251d43208854f5e8bea7308b15c428e135",
    "FlvUrl": "",
    "RtmpUrl": ""
  },
  "StartTime": "2020-09-03 12:30:00",
  "EndTime": "2020-09-03 12:35:26",
  "Duration": 0,
  "FileFormat": "hls",
  "RequestId": "2aeb99aff02a49e2aae6e1592190d8f8",
  "DownloadUrl": "http://127.0.0.1:7480/record-rh/record/hls/device/29942058487644187/2020-09-03-12-30-00/playlist.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=c8x8v3YdlxxxxxTVD8lU%2F20200903%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20200903T062237Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=5d4615066487c0a9b81b059ff8e49c5fbf066e081575eb92117acaf3b2c6f127"
}

5. 错误码

ErrorCode	ErrorMessage

查询录制文件

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

1. 接口描述

2. 请求参数

3. 返回参数

Video

PlayUrl

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码