DescribeRtcCloudRecordingFiles - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries information about RTC cloud recording files and tasks.

Operation description

QPS limit

The queries per second (QPS) limit for this API is 50 calls per second for each user. If you exceed the limit, API calls are throttled, which can affect your business. Call this API operation at a reasonable rate to avoid throttling.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeRtcCloudRecordingFiles

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The task ID returned when you start an RTC cloud recording.	****73-8501--8ac1-72295a****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	****58-5876--83CA-B56278****
TaskInfo	object	The task information.
TaskId	string	The task ID.	****73-8501--8ac1-72295a****
Status	string	The task status: RUNNING RECOVERING STOPPING STOPPED	RUNNING
RecordFileList	object	The list of recording files.
Mp3FileList	array	An array of recording file names in MP3 format.
	string	The name of a recording file in MP3 format.	****73-8501--8ac1-72295a****/myappid_testroom_userA_2025-05-06-14:37:22.mp3
Mp4FileList	array	An array of recording file names in MP4 format.
	string	The name of a recording file in MP4 format.	****73-8501--8ac1-72295a****/myappid_testroom_userA_2025-05-06-14:37:22.mp4
HlsFileList	array	An array of recording file names in HLS format.
	string	The name of a recording file in HLS format.	****73-8501--8ac1-72295a****/myappid_testroom_userA_2025-05-06-14:37:22.m3u8
VodMediaList	array<object>	An array of VOD media resources. When recording to VOD, this is a collection of recording files for each subscribed stream. Each item corresponds to a subscribed stream.
	object	The media resource information for a subscribed stream.
Stream	string	The subscribed stream. For stream mixing recordings, the value is `Mix`. For single-stream recordings, the value is `Single::{UserId}::{Suffix}`. `UserId` is the user ID for the stream. The `Suffix` depends on the `StreamType` and `SourceType` specified during subscription. If `StreamType` is 0: `Suffix` is `AV::C` if `SourceType` is 0, or `AV::S` if `SourceType` is 1. If `StreamType` is 1: `Suffix` is `A`. If `StreamType` is 2 (not supported for single-stream recording): `Suffix` is `V::C` if `SourceType` is 0, or `V::S` if `SourceType` is 1.	Single::UserA::AV::C
MediaIds	array	An array of media resource IDs generated during the recording.
	string	A media resource ID generated during the recording.	**bbd9f59c71ee80065017f0f8**
MergedIds	array	An array of media resource IDs that are automatically merged after the recording ends.
	string	A media resource ID that is automatically merged after the recording ends.	**d2f9f59c71ee8006501790g7**

Examples

Success response

JSON format

{
  "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****"
          ]
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotFound.Task	%s, please check the TaskId.	The parameter TaskId does not exist.
400	InvalidParameter.TaskId	%s, please check the TaskId.	The specified task must be in the running or recovering state.
400	MissingParameter	%s.	Missing parameter
403	InvalidParameter.UserId	%s, please check the UserId.	UserId is invalid, please check.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.