全部產品
Search
文件中心

ApsaraVideo Live:DescribeRtcCloudRecordingFiles - 查詢Rtc雲端錄製檔案及任務狀態

更新時間:Aug 19, 2025

查詢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無效,請檢查。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情