ListLiveRecordFiles - - Alibaba Cloud Documentation Center

Queries all recording index files in the specified period of time.

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

ice:ListLiveRecordFiles

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EndTime	string	No	The end of the time range to query. The maximum time range to query is four days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-22T08:00:00Z
StartTime	string	No	The beginning 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.	2017-12-21T08:00:01Z
JobIds	array	No	The list of job IDs.
	string	No	The ID of the recording job.	9E83D5D0-8D72-5E7D-B61A-****
PageNo	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 5 to 30. Default value: 10.	10
SortBy	string	No	The sorting order of the index files by creation time. Valid values: asc: The query results are displayed in ascending order. This is the default value. desc: The query results are displayed in descending order.	asc
RecordFormat	string	No	The format of the recording file. Valid values: M3U8, FLV, and MP4	m3u8

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DE24625C-7C0F-4020-8448-****
PageNo	integer	The page number.	1
SortBy	string	The sorting order of the index files by creation time.	asc
PageSize	string	The number of entries per page.	10
TotalCount	string	The total number of files that meet the specified conditions.	100
Files	array<object>	The list of index files.
	object
RecordUrl	string	The URL of the index file.	http://**/atestObject**.m3u8
StartTime	string	The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-01T07:36:00Z
EndTime	string	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-01T07:36:10Z
Duration	number	The recording length. Unit: seconds.	100.0
Width	integer	The width of the video.	480
Height	integer	The height of the video.	640
CreateTime	string	The time when the file was created in UTC.	2016-05-27T09:40:56Z
RecordOutput	string	The storage information about the recording file.	{ "Type": "oss", "Endpoint":"oss-cn-shanghai.aliyuncs.com", "Bucket": "test-bucket" }
RecordId	string	The ID of the index file.	c4d7f0a4-b506-43f9-8de3-07732c3f****
StreamUrl	string	The name of the live stream.	LiveStream***
JobName	string	The name of the recording job.	LiveRecordJob***
Format	string	The format of the recording file.	m3u8
JobId	string	The ID of the recording job.	c4d7f0a4-b506-43f9-8de3-07732c3f****

Examples

Success response

JSON format

{
  "RequestId": "DE24625C-7C0F-4020-8448-****",
  "PageNo": 1,
  "SortBy": "asc",
  "PageSize": "10",
  "TotalCount": "100",
  "Files": [
    {
      "RecordUrl": "http://****/atestObject****.m3u8",
      "StartTime": "2015-12-01T07:36:00Z",
      "EndTime": "2015-12-01T07:36:10Z",
      "Duration": 100,
      "Width": 480,
      "Height": 640,
      "CreateTime": "2016-05-27T09:40:56Z",
      "RecordOutput": "{ \"Type\": \"oss\", \"Endpoint\":\"oss-cn-shanghai.aliyuncs.com\", \"Bucket\": \"test-bucket\" }",
      "RecordId": "c4d7f0a4-b506-43f9-8de3-07732c3f****",
      "StreamUrl": "LiveStream***",
      "JobName": "LiveRecordJob***",
      "Format": "m3u8",
      "JobId": "c4d7f0a4-b506-43f9-8de3-07732c3f****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.