DescribeRecordFiles - - Alibaba Cloud Documentation Center

Description

This interface is used to query the list of files generated by recording. For example, you can query parameters such as the creation time and recording duration of the recording generated file.

QPS limit

You can send up to 10 requests per second to call this operation by using your Alibaba Cloud account. If the number of the calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeRecordFiles	The operation that you want to perform. Set the value to DescribeRecordFiles.
AppId	String	Yes	yourAppId	The ID of the application. Only Flyer IDs are supported. You can create and query them in the console.
ChannelId	String	No	yourChannelId	The ID of the channel. Only flyer IDs are supported.
PageSize	Integer	No	10	The number displayed on each page. Default value: 10.
PageNum	Integer	No	1	Page 1 is queried by default.
TaskIds.N	RepeatList	No	yourTaskId	The ID of the recording task (the same as the TaskId in the StartRecordTask input parameter). Up to 10 tasks can be queried in batches. Formats: `TaskIds.1=** TaskIds.2=** ......`
StartTime	String	No	2020-11-01T17:36:00Z	The beginning of the time range in which the resource usage data was queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
EndTime	String	No	2020-11-02T17:36:00Z	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters


Parameter	Type	Example	Description
RecordFiles	Array of RecordFile		The IDs of the media files.
AppId	String	yourAppId	The ID of the application.
ChannelId	String	yourChannelId	The ID of the channel. Only flyer IDs are supported.
CreateTime	String	2020-10-02T17:36:00Z	The time at which the DAG was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
Duration	Float	1800	The duration of the recording file. Unit: seconds.
StartTime	String	2020-11-01T17:36:00Z	The beginning of the time range in which the resource usage data was queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
StopTime	String	2020-11-02T17:36:00Z	The beginning of the time range in which the resource usage data was queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
TaskId	String	yourTaskId	The ID of the task.
Url	String	http://rtc-demo.oss-cn-**.aliyuncs.com/record/10-15-1/**/record-002_yourTaskId/example.m3u8	The OSS URL of the recording file.
RequestId	String	760bad53276431c499e30dc36f6b****	The ID of the request.
TotalNum	Long	1	The number of returned results.
TotalPage	Long	1	The number of pages to return.

Examples

Sample requests

https://rtc.aliyuncs.com?Action=DescribeRecordFiles
&AppId=yourAppId
&<Common request parameters>

Sample success responses

XML format

<DescribeRecordFilesResponse>
  <TotalNum>3</TotalNum>
	  <RequestId>AB2D3461-2F88-43DC-B60F-2F4C9BDB6522</RequestId>
	  <TotalPage>1</TotalPage>
	  <RecordFiles>
		    <TaskId>yourTaskId</TaskId>
		    <AppId>9qb1zcyc</AppId>
		    <CreateTime>2020-11-17T05:08:12Z</CreateTime>
		    <StartTime>2020-11-17T04:40:28Z</StartTime>
		    <Duration>1482.29</Duration>
		    <ChannelId>record-002</ChannelId>
		    <Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-40-28_2020-11-17-13-05-10.m3u8</Url>
		    <StopTime>2020-11-17T05:05:11Z</StopTime>
	  </RecordFiles>
	  <RecordFiles>
		    <TaskId>yourTaskId</TaskId>
		    <AppId>9qb1zcyc</AppId>
		    <CreateTime>2020-11-17T04:40:37Z</CreateTime>
		    <StartTime>2020-11-17T04:10:27Z</StartTime>
		    <Duration>1800.01</Duration>
		    <ChannelId>record-002</ChannelId>
		    <Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-10-28_2020-11-17-12-40-28.m3u8</Url>
		    <StopTime>2020-11-17T04:40:28Z</StopTime>
	  </RecordFiles>
	  <RecordFiles>
		    <TaskId>yourTaskId</TaskId>
		    <AppId>9qb1zcyc</AppId>
		    <CreateTime>2020-11-17T04:10:34Z</CreateTime>
		    <StartTime>2020-11-17T03:40:28Z</StartTime>
		    <Duration>1799.95</Duration>
		    <ChannelId>record-002</ChannelId>
		    <Url>http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-11-40-28_2020-11-17-12-10-28.m3u8</Url>
		    <StopTime>2020-11-17T04:10:28Z</StopTime>
	  </RecordFiles>
    </DescribeRecordFilesResponse>

JSON format

{
    "TotalNum": 3,
    "RequestId": "AB2D3461-2F88-43DC-B60F-2F4C9BDB6522",
    "TotalPage": 1,
    "RecordFiles": [
        {
            "TaskId": "yourTaskId",
            "AppId": "9qb1zcyc",
            "CreateTime": "2020-11-17T05:08:12Z",
            "StartTime": "2020-11-17T04:40:28Z",
            "Duration": 1482.29,
            "ChannelId": "record-002",
            "Url": "http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-40-28_2020-11-17-13-05-10.m3u8",
            "StopTime": "2020-11-17T05:05:11Z"
        },
        {
            "TaskId": "yourTaskId",
            "AppId": "9qb1zcyc",
            "CreateTime": "2020-11-17T04:40:37Z",
            "StartTime": "2020-11-17T04:10:27Z",
            "Duration": 1800.01,
            "ChannelId": "record-002",
            "Url": "http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-12-10-28_2020-11-17-12-40-28.m3u8",
            "StopTime": "2020-11-17T04:40:28Z"
        },
        {
            "TaskId": "yourTaskId",
            "AppId": "9qb1zcyc",
            "CreateTime": "2020-11-17T04:10:34Z",
            "StartTime": "2020-11-17T03:40:28Z",
            "Duration": 1799.95,
            "ChannelId": "record-002",
            "Url": "http://rtc-demo.oss-cn-****.aliyuncs.com/record/10-15-1/****/record-002_yourTaskId/2020-11-17-11-40-28_2020-11-17-12-10-28.m3u8",
            "StopTime": "2020-11-17T04:10:28Z"
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.

Special error codes


Error code	Description	HTTP status code	Description
InternalError	The request processing has failed due to some unknown error, exception or failure.	500	The error message returned because an internal error occurred.