实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考云端录制查询录制任务状态 GetRecordTask
复制全文
下载 pdf查询录制任务状态 GetRecordTask
文档反馈
问问助手调用 GetRecordTask 接口，查询指定云端录制任务的详细信息，包括任务状态、起止时间、录制文件列表等。适用于查询 72 小时内启动的任务。
注意事项
请求频率：QPS 不得超过 60。
请求说明
- 请求方式：GET
- 请求地址：https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：GetRecordTask
接口名称。当前 API 的名称为 GetRecordTask。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId String 必选 示例值：66****3cf
RoomId String 必选 示例值：Room1
目标房间 ID。
TaskId String 必选 示例值：Task1
要查询的云端录制任务 ID。
返回参数
RecordTask Object 示例值：-
录制任务信息
StartTime Long 示例值：1624873773000
任务开始的时间，为 Unix 时间戳，单位为毫秒。
EndTime Long 示例值：1624874235000
任务结束的时间，为 Unix 时间戳，单位为毫秒。0 表示任务未结束。
Status Long 示例值：1
任务状态。取值及含义如下：
- 0：未知异常状态
- 1：未开始
- 2：运行中
- 3：已结束
- 4：任务运行失败
StopReason String 示例值：StopByAPI
任务停止的原因。取值及含义如下：
- 空：表示任务未结束
- UnknownStopReason：未知停止原因
- StopByAPI：用户主动通过 API 停止
- StartTaskFailed：任务启动失败
- IdleTimeOut：超过了最大空闲时间
RecordFileList Object[] 示例值：-
录制生成的文件列表。
当Status=2时，仅当EnableSyncUpload = true，且FileFormatConfig.FileFormat包含HLS时，RecordFileList 返回 HLS 录制文件信息，其他情况下为空。
Vid String 示例值：v02b69g10000***eldb8vjafvmg
ObjectKey String 示例值：abc/efg/123.mp4
文件在对象存储平台中的完整路径，如abc/efg/123.mp4。仅在你选择配置存储到对象存储平台时，此参数有效。
Duration Long 示例值：457280
文件时长，单位为毫秒。
Size Long 示例值：30388433
文件大小，单位为字节。
StartTime Long 示例值：1624873773354
当前录制文件创建的时间，为 Unix 时间戳，单位为毫秒。
StreamList Object[] 示例值：-
录制文件中包含流的列表。
Index Integer 示例值：0
视频流的唯一索引，用于在自定义布局中标识该视频流。在 Layout.regions.StreamIndex 中会引用此 Index 来配置对应视频流的布局。
在一个 StreamList 中，Stream.Index 不能重复。
UserId String 示例值：user1
目标视频流所属的用户 ID。
StreamType Integer 示例值：0
流的类型：
- 0：普通音视频流。
- 1：屏幕共享流。
videoCodec String 示例值：h264
视频录制编码协议。
- h264：H.264 编码协议。
- bytevc1：ByteVC1 编码协议。
audioCodec String 示例值：aac
音频录制编码器。仅支持 aac。
videoWidth Integer 示例值：640
录制视频宽度，单位为像素。
videoHeight Integer 示例值：480
录制视频高度，单位为像素。
请求示例
返回示例
错误码
最近更新时间：2026.08.21 13:49:59
这个页面对您有帮助吗？
有用
有用
无用
无用