PlayCloudRecord - 播放云端录像--慢直播-火山引擎

文档中心

立即注册

导航

PlayCloudRecord - 播放云端录像

最近更新时间：2025.06.17 20:01:27首次发布时间：2024.02.29 14:55:33

播放云端录像

使用说明

配置录制模板，完成录像上云，通过此API获取任意时间段内的录像回放。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=PlayCloudRecord&Version=2023-10-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	PlayCloudRecord	要执行的操作，取值：PlayCloudRecord。
Version	String	是	2023-10-01	API的版本，取值：2023-10-01。
SpaceID	String	否	spaceuuidxxxxx	流所属空间ID
StreamID	String	是	e4b32f7a-85cb-4370-aa07-cad62ab4c8a4	主码流 ID，可通过 ListStreams 接口获取。
StreamingIndex	Integer	否	0	主子码流索引： 0：主码流（默认值）； 1~n：子码流。
Resolution	String	否	2	分辨率编码（可参考 GB28181-2022 协议附录G中的定义）。
StartTime	Long	是	1699436336	查询视频录像开的始时间，Unix 时间戳，单位为秒。
EndTime	Long	是	1699436436	查询视频录像的结束时间，Unix 时间戳，单位为秒。查询的起始时间最多 24 小时。
TokenValid	Integer	否	3600	返回视频录像播放地址的 token 有效期，单位秒，默认值为 3600。
WithSub	Boolean	否	false	是否合并主子码流录像，支持的取值如下所示。 false：不合并（默认值）； true：合并。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
hls	String	https://aiot-gateway.zijieapi.com/media_record/v1/file/index.m3u8?StreamID=xxxx&IsLive=0&X-JWT-Token=ZXlKxxxxrmat=m3u8	HLS 播放地址。
mp4	String	https://aiot-gateway.zijieapi.com/media_record/v1/file/main.mp4?StreamID=xxxx&IsLive=0&X-JWT-Token=ZXlKaGJHY2lxxx941599000&Pub=1&Format=mp4	MP4 播放地址。

请求示例

POST https://open.volcengineapi.com?Action=PlayCloudRecord&Version=2023-10-01

返回示例

{
    "ResponseMetadata": {
        "Action": "PlayCloudRecord",
        "Region": "cn-north-1",
        "RequestId": "20240125120631AB5FC3AFB0269344390C",
        "Service": "aiotvideo",
        "Version": "2023-10-01"
    },
    "Result": {
        "hls": "https://aiot-gateway.zijieapi.com/media_record/v1/file/index.m3u8?StreamID=xxxx&IsLive=0&X-JWT-Token=ZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SkJZMk52ZFc1MFNVUWlPakl4TURBeU16WXhOVGNzSW1WNGNDSTZNVGN3TmpJME1UazVNU3dpYVhOeklqb2lZV2x2ZEY5elpYSjJaWElpTENKRmVIUnlZU0k2ZXlKUVpYSnRhWE56YVc5dUlqb2lPQ0o5ZlEuN3Vta0VINWJ3WXIteURlZExGTUY2eHBzS1lWb1RtLUM2MFUwWmhRTXdEbw==&X-FROM=aiot_server&TokenExpire=86400&Start=1704941499000&End=1704941599000&Pub=1&Format=m3u8",
        "mp4": "https://aiot-gateway.zijieapi.com/media_record/v1/file/main.mp4?StreamID=xxxx&IsLive=0&X-JWT-Token=ZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SkJZMk52ZFc1MFNVUWlPakl4TURBeU16WXhOVGNzSW1WNGNDSTZNVGN3TmpJME1UazVNU3dpYVhOeklqb2lZV2x2ZEY5elpYSjJaWElpTENKRmVIUnlZU0k2ZXlKUVpYSnRhWE56YVc5dUlqb2lPQ0o5ZlEuN3Vta0VINWJ3WXIteURlZExGTUY2eHBzS1lWb1RtLUM2MFUwWmhRTXdEbw==&X-FROM=aiot_server&TokenExpire=86400&Start=1704941499000&End=1704941599000&Pub=1&Format=mp4"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrorDeviceCloudPlayArgErr	InvalidParameter.CloudPlay