DescribeLiveStreamRecordIndexFile - ApsaraVideo Live

Queries the configuration of an index file.

Operation description

Usage notes

ApsaraVideo Live stores the configuration information of an M3U8 index file for six months. You can query only index files created in the previous six months. M3U8 index files are stored in Object Storage Service (OSS) buckets. The retention period is determined by the storage configuration of the OSS buckets.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveStreamRecordIndexFile	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	Usage notes ApsaraVideo Live stores the configuration information of an M3U8 index file for six months. You can query only index files created in the previous six months. M3U8 index files are stored in Object Storage Service (OSS) buckets. The retention period is determined by the storage configuration of the OSS buckets. QPS limit You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.	example.com
AppName	string	Yes	System-defined parameter. Value: DescribeLiveStreamRecordIndexFile.	liveApp****
StreamName	string	Yes	The main domain of the live stream.	liveStream****
RecordId	string	Yes	The name of the application to which the live stream belongs.	c4d7f0a4-b506-43f9-8de3-07732c3f****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The name of the live stream.	5EBF2AC3-4B73-40A5-8B32-83F49D5F035E
RecordIndexInfo	object	The ID of the M3U8 index file.
RecordUrl	string	The ID of the request.	http://**/atestObject**.m3u8
StreamName	string	The recording configuration.	liveStream****
CreateTime	string	The URL of the M3U8 index file.	2016-05-27T09:40:56Z
RecordId	string	The name of the live stream.	c4d7f0a4-b506-43f9-8de3-07732c3f****
Height	integer	The time when the M3U8 index file was created. Format: yyyy-MM-ddTHH:mm:ssZ. The time is displayed in UTC.	480
OssBucket	string	The ID of the M3U8 index file.	liveBucket****
DomainName	string	The height of the video.	example.com
OssObject	string	The name of the OSS bucket in which the M3U8 index file is stored.	liveObject****
EndTime	string	The main domain of the live stream.	2016-05-25T05:47:11Z
AppName	string	The name of the recording that is stored in OSS.	liveApp****
StartTime	string	The end of the time range of the M3U8 index file. Format: yyyy-MM-ddTHH:mm:ssZ. The time is displayed in UTC.	2015-12-01T05:36:00Z
Width	integer	The name of the application to which the live stream belongs.	640
Duration	float	The beginning of the time range of the M3U8 index file. Format: yyyy-MM-ddTHH:mm:ssZ. The time is displayed in UTC.	588.849
OssEndpoint	string	The width of the video.	cn-oss-****.aliyuncs.com
Format	string	The recording length. Unit: seconds.	mp4

Examples

Sample success responses

JSONformat

{
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "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": "2016-05-25T05:47:11Z",
    "AppName": "liveApp****",
    "StartTime": "2015-12-01T05:36:00Z",
    "Width": 640,
    "Duration": 588.849,
    "OssEndpoint": "cn-oss-****.aliyuncs.com",
    "Format": "mp4"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-25	The response structure of the API has changed	View Change Details