DescribeLiveStreamRecordIndexFile - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

ApsaraVideo Live stores the information about M3U8 index files for only six months. You can query only the information about the M3U8 index files that are 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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveStreamRecordIndexFile	The operation that you want to perform. Set the value to DescribeLiveStreamRecordIndexFile.
DomainName	String	Yes	example.com	The main streaming domain.
AppName	String	Yes	liveApp****	The name of the application to which the live stream belongs.
StreamName	String	Yes	liveStream****	The name of the live stream.
RecordId	String	Yes	c4d7f0a4-b506-43f9-8de3-07732c3f****	The ID of the index file. Note You can call the DescribeLiveStreamRecordIndexFiles operation to obtain the ID.

Response parameters

Parameter	Type	Example	Description
RequestId	String	5EBF2AC3-4B73-40A5-8B32-83F49D5F035E	The request ID.
RecordIndexInfo	Object		The information about the index file.
RecordUrl	String	http://**/atestObject**.m3u8	The URL of the index file.
StreamName	String	liveStream****	The name of the live stream.
CreateTime	String	2016-05-27T09:40:56Z	The time when the 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 index file.
Height	Integer	480	The video height.
OssBucket	String	liveBucket****	The name of the Object Storage Service (OSS) bucket.
DomainName	String	example.com	The main streaming domain.
OssObject	String	liveObject****	The name of the storage file in OSS.
EndTime	String	2016-05-25T05:47:11Z	The end time of the index file. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
AppName	String	liveApp****	The name of the application to which the live stream belongs.
StartTime	String	2015-12-01T05:36:00Z	The start time of the index file. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Width	Integer	640	The video width.
Duration	Float	588.849	The recording length. Unit: seconds.
OssEndpoint	String	cn-oss-****.aliyuncs.com	The endpoint of the OSS bucket.
Format	String	mp4	The video format.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamRecordIndexFile
&AppName=liveApp****
&DomainName=example.com
&RecordId=c4d7f0a4-b506-43f9-8de3-07732c3f****
&StreamName=liveStream****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamRecordIndexFileResponse>
    <RecordIndexInfo>
        <EndTime>2016-05-25T05:47:11Z</EndTime>
        <DomainName>example.com</DomainName>
        <CreateTime>2016-05-27T09:40:56Z</CreateTime>
        <StartTime>2015-12-01T05:36:00Z</StartTime>
        <OssBucket>liveBucket****</OssBucket>
        <Duration>588.849</Duration>
        <AppName>liveApp****</AppName>
        <StreamName>liveStream****</StreamName>
        <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
        <RecordUrl>http://****/atestObject****.m3u8</RecordUrl>
        <OssObject>liveObject****</OssObject>
        <Height>480</Height>
        <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>
        <Width>640</Width>
        <Format>mp4</Format>
    </RecordIndexInfo>
    <RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>
</DescribeLiveStreamRecordIndexFileResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveStreamRecordIndexFileResponse" : {
    "RecordIndexInfo" : {
      "EndTime" : "2016-05-25T05:47:11Z",
      "DomainName" : "example.com",
      "CreateTime" : "2016-05-27T09:40:56Z",
      "StartTime" : "2015-12-01T05:36:00Z",
      "OssBucket" : "liveBucket****",
      "Duration" : 588.849,
      "AppName" : "liveApp****",
      "StreamName" : "liveStream****",
      "OssEndpoint" : "cn-oss-****.aliyuncs.com",
      "RecordUrl" : "http://****/atestObject****.m3u8",
      "OssObject" : "liveObject****",
      "Height" : 480,
      "RecordId" : "c4d7f0a4-b506-43f9-8de3-07732c3f****",
      "Width" : 640,
      "Format" : "mp4"
    },
    "RequestId" : "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E"
  }
}

Error codes

For a list of error codes, see Service error codes.