DescribeLiveStreamRecordIndexFiles - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries all recording manifests within a specified time range.

Operation description

Metadata for created M3U8 manifests is retained in ApsaraVideo Live for 6 months. You can only query information about manifests created within this period.
OSS stores M3U8 index files for a time period that is specified by the storage configuration in OSS.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.

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:DescribeLiveStreamRecordIndexFiles

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	Yes	The AppName of the live stream.	liveApp****
StreamName	string	Yes	The name of the live stream.	liveStream****
StartTime	string	Yes	The start time for the query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time for the query. The time range between StartTime and EndTime cannot exceed 4 days. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-22T08:00:00Z
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 5 to 30. Default value: 10.	10
Order	string	No	The order in which the entries are sorted based on creation time. Valid values: asc (default): ascending order desc: descending order	asc

Response elements

Element	Type	Description	Example
	object
PageNum	integer	The page number.	10
RequestId	string	The request ID.	DE24625C-7C0F-4020-8448-9C31A50C1556
Order	string	The sort order.	asc
TotalPage	integer	The total number of pages.	20
PageSize	integer	The number of entries per page.	5
TotalNum	integer	The total number of entries that meet the specified conditions.	12
RecordIndexInfoList	object
RecordIndexInfo	array<object>	The manifests.
	object
RecordUrl	string	The URL of the manifest.	http://**/atestObject**.m3u8
StreamName	string	The stream name.	liveStream****
CreateTime	string	The creation time.	2016-05-27T09:40:56Z
RecordId	string	The manifest ID.	c4d7f0a4-b506-43f9-8de3-07732c3f****
Height	integer	The video height.	480
OssBucket	string	The name of the Object Storage Service (OSS) bucket.	liveBucket****
DomainName	string	The main streaming domain.	example.com
OssObject	string	The path and file name of the recording in OSS.	liveObject****
EndTime	string	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-01T07:46:00Z
AppName	string	The AppName of the live stream.	liveApp****
StartTime	string	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-01T07:36:00Z
Width	integer	The video width.	640
Duration	number	The recording duration. Unit: seconds.	588.849
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com
Format	string	The video format.	HLS

Examples

Success response

JSON format

{
  "PageNum": 10,
  "RequestId": "DE24625C-7C0F-4020-8448-9C31A50C1556",
  "Order": "asc",
  "TotalPage": 20,
  "PageSize": 5,
  "TotalNum": 12,
  "RecordIndexInfoList": {
    "RecordIndexInfo": [
      {
        "RecordUrl": "http://****/atestObject****.m3u8",
        "StreamName": "liveStream****",
        "CreateTime": "2016-05-27T09:40:56Z",
        "RecordId": "c4d7f0a4-b506-43f9-8de3-07732c3f****",
        "Height": 480,
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "OssObject": "liveObject****",
        "EndTime": "2015-12-01T07:46:00Z",
        "AppName": "liveApp****",
        "StartTime": "2015-12-01T07:36:00Z",
        "Width": 640,
        "Duration": 588.849,
        "OssEndpoint": "cn-oss-****.aliyuncs.com",
        "Format": "HLS"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStartTime.Mismatch	Specified StartTime does not math the current time.
400	Forbidden	Ram Permission is forbidden.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.