DescribeRtcCloudRecordingFiles - 查询Rtc云端录制文件及任务状态

查询rtc云端录制文件与任务信息。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeRtcCloudRecordingFiles

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TaskId

string

启动 Rtc 云端录制时返回的任务 id。

******73-8501-****-8ac1-72295a******

返回参数

名称

类型

描述

示例值

object

返回内容。

RequestId

string

请求 id。

******58-5876-****-83CA-B56278******

TaskInfo

object

任务信息。

TaskId

string

任务 id。

******73-8501-****-8ac1-72295a******

Status

string

任务状态:

  • RUNNING

  • RECOVERING

  • STOPPING

  • STOPPED

RUNNING

RecordFileList

object

录制文件列表。

Mp3FileList

array

mp3 格式录制文件名数组。

string

mp3 格式录制文件名。

******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp3

Mp4FileList

array

mp4 格式录制文件名数组。

string

mp4 格式录制文件名。

******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp4

HlsFileList

array

hls 格式录制文件名数组。

string

hls 格式录制文件名。

******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.m3u8

VodMediaList

array<object>

VOD 媒体资源数组。录制到 VOD 时,订阅的各个流的录制文件集合,其中每一项对应着一个订阅流。

object

对应订阅的某条流的媒体资源信息。

Stream

string

表示订阅的流

  • 对于混流录制,值统一为 Mix

  • 对于单流录制,值为 Single::{UserId}::{Suffix}
    • UserId 为这条流对应的 UserId

    • Suffix 与订阅时填写的 StreamType 和 SourceType 有关
      • 当 StreamType 为 0 时:如果 SourceType 为 0,那么 Suffix 为 AV::C;如果 SourceType 为 1,那么 Suffix 为 AV::S

      • 当 StreamType 为 1 时:Suffix 只能为 A

      • 当 StreamType 为 2 时(单流录制暂不支持):如果 SourceType 为 0,那么 Suffix 为 V::C;如果 SourceType 为 1,那么 Suffix 为 V::S

Single::UserA::AV::C

MediaIds

array

录制过程中生成的媒体资源 id 数组。

string

录制过程中生成的媒体资源 id。

****bbd9f59c71ee80065017f0f8****

MergedIds

array

录制结束后生成的自动合并的媒体资源 id 数组。

string

录制结束后生成的自动合并的媒体资源 id。

****d2f9f59c71ee8006501790g7****

示例

正常返回示例

JSON格式

{
  "RequestId": "******58-5876-****-83CA-B56278******\n",
  "TaskInfo": {
    "TaskId": "******73-8501-****-8ac1-72295a******\n",
    "Status": "RUNNING",
    "RecordFileList": {
      "Mp3FileList": [
        "******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp3"
      ],
      "Mp4FileList": [
        "******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp4"
      ],
      "HlsFileList": [
        "******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.m3u8"
      ],
      "VodMediaList": [
        {
          "Stream": "Single::UserA::AV::C",
          "MediaIds": [
            "****bbd9f59c71ee80065017f0f8****"
          ],
          "MergedIds": [
            "****d2f9f59c71ee8006501790g7****"
          ]
        }
      ]
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 NotFound.Task %s, please check the TaskId. 参数TaskId不存在。
400 InvalidParameter.TaskId %s, please check the TaskId. 指定的task必须处于运行中或者恢复中状态。
400 MissingParameter %s. 参数缺失
403 InvalidParameter.UserId %s, please check the UserId. UserId无效,请检查。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情