You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/云端录制/查询录制任务状态 GetRecordTask
查询录制任务状态 GetRecordTask
最近更新时间：2024.08.23 14:08:34首次发布时间：2024.01.03 20:25:17
我的收藏

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需获取特定录制任务的详细信息，你可通过调用此接口实现查询。

此接口适用于查询 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
是
661e****543cf
你的音视频应用的唯一标志
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
文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
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
在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserId
String
user1
用户 ID，表示这个流所属的用户。
StreamType
Integer
0

流的类型。支持取值及含义如下：

  • 0：普通音视频流，
  • 1：屏幕流。
默认值为0。
VideoCodec
String
0
视频录制编码协议
AudioCodec
String
0
音频录制编码器
VideoWidth
Integer
640
录制视频宽度，单位为像素。
VideoHeight
Integer
480
录制视频高度，单位为像素。

请求示例

GET https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&TaskId=Task1

返回示例

{
    "Result": {
        "RecordTask": {
            "StartTime": 1624873773000,
            "EndTime": 1624874235000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "RecordFileList": [
                {
                    "Vid": "v02b69g10000***eldb8vjafvmg",
                    "Duration": 457280,
                    "Size": 30388433,
                    "StartTime": 1624873773354,
                    "StreamList": [
                        {
                            "UserId": "user1",
                            "StreamType": 0
                        }
                    ]
                }
            ]
        }
    },
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "GetRecordTask",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。