Queries the information about an index file.
Operation description
ApsaraVideo Live stores the information about M3U8 index files for six months. You can query the information about only the M3U8 index files that were created in the last six months. 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 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
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 Resourcesis 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 |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | Usage notesApsaraVideo 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 limitYou 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 ID of the index file. Note
You can call the DescribeLiveStreamRecordIndexFiles operation to query the ID.
| c4d7f0a4-b506-43f9-8de3-07732c3f**** |
Response parameters
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 |