Queries the information about an M3U8 index file.
Usage note
- ApsaraVideo Live stores the information about M3U8 index files only for six months. You can query only the information about the M3U8 index files that are created in the previous six months.
- Object Storage Service (OSS) stores M3U8 index files for a time period that is specified by the storage configuration.
QPS limit
A single user can perform a maximum of 100 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveStreamRecordIndexFile |
The operation that you want to perform. Set the value to DescribeLiveStreamRecordIndexFile. |
AppName | String | Yes | liveApp**** |
The name of the application to which the live stream belongs. |
DomainName | String | Yes | example.com |
The main streaming domain. |
RecordId | String | Yes | c4d7f0a4-b506-43f9-8de3-07732c3f**** |
The ID of the M3U8 index file. |
StreamName | String | Yes | liveStream**** |
The name of the live stream. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RecordIndexInfo | Struct |
The recording configuration. |
|
RecordUrl | String | http://****/atestObject.m3u8 |
The URL of the M3U8 index file. |
DomainName | String | example.com |
The main streaming domain. |
AppName | String | liveApp**** |
The name of the application to which the live stream belongs. |
StreamName | String | liveStream**** |
The name of the live stream. |
OssBucket | String | tes123 |
The name of the OSS bucket in which the M3U8 index file is stored. |
OssEndpoint | String | oss-cn-hangzhou.aliyuncs.com |
The endpoint of OSS. |
OssObject | String | liveBucket**** |
The name of the recording that is stored in OSS. |
StartTime | String | 2015-12-01T05:36:00Z |
The beginning of the recording for which the M3U8 index file is created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
EndTime | String | 2016-05-25T05:47:11Z |
The end of the recording for which the M3U8 index file is created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Duration | Float | 588.849 |
The recording length. Unit: seconds. |
Height | Integer | 480 |
The height of the video. |
Width | Integer | 640 |
The width of the video. |
CreateTime | String | 2016-05-27T09:40:56Z |
The time when the M3U8 index file was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
RecordId | String | c4d7f0a4-b506-43f9-8de3-07732c3f**** |
The ID of the M3U8 index file. |
RequestId | String | 5EBF2AC3-4B73-40A5-8B32-83F49D5F035E |
The ID of the request. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamRecordIndexFile
&AppName=liveApp****
&DomainName=example.com
&RecordId=c4d7f0a4-b506-43f9-8de3-07732c3f****
&StreamName=testStream
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveStreamRecordIndexFileResponse>
<RecordIndexInfo>
<AppName>liveApp****</AppName>
<CreateTime>2016-05-27T09:40:56Z</CreateTime>
<DomainName>example.com</DomainName>
<Duration>588.849</Duration>
<EndTime>2016-05-25T05:47:11Z</EndTime>
<Height>480</Height>
<OssBucket>liveBucket****</OssBucket>
<OssEndpoint>oss-cn-hangzhou.aliyuncs.com</OssEndpoint>
<OssObject>atestObject.m3u8</OssObject>
<RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>
<RecordUrl>http://****/atestObject.m3u8</RecordUrl>
<StartTime>2016-05-25T05:37:11Z</StartTime>
<StreamName>liveStream****</StreamName>
<Width>640</Width>
</RecordIndexInfo>
<RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>
</DescribeLiveStreamRecordIndexFileResponse>
JSON
format
{
"RecordIndexInfo":{
"AppName":"liveApp****",
"CreateTime":"2016-05-27T09:40:56Z",
"DomainName":"example.com",
"Duration":588.849,
"EndTime":"2016-05-25T05:47:11Z",
"Height":480,
"OssBucket":"liveBucket****",
"OssEndpoint":"oss-cn-hangzhou.aliyuncs.com",
"OssObject":"atestObject.m3u8",
"RecordId":"c4d7f0a4-b506-43f9-8de3-07732c3f****",
"RecordUrl":"http://****/atestObject.m3u8",
"StartTime":"2016-05-25T05:37:11Z",
"StreamName":"liveStream****",
"Width":640
},
"RequestId":"5EBF2AC3-4B73-40A5-8B32-83F49D5F035E"
}
Error codes
For a list of error codes, visit the API Error Center.