DescribeLiveStreamRecordIndexFiles - ApsaraVideo Live

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 15 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	DescribeLiveStreamRecordIndexFiles	The operation that you want to perform. Set the value to DescribeLiveStreamRecordIndexFiles.
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.
StartTime	String	Yes	2017-12-21T08:00:00Z	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
EndTime	String	Yes	2017-12-22T08:00:00Z	The end of the time range to query. The time range that is specified by the StartTime and EndTime parameters cannot exceed four days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
PageNum	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Valid values: 5 to 30. Default value: 10.
Order	String	No	asc	The order in which the entries are sorted based on creation time. Valid values: asc (default): ascending order desc: descending order

Response parameters

Parameter	Type	Example	Description
PageNum	Integer	10	The page number.
RequestId	String	DE24625C-7C0F-4020-8448-9C31A50C1556	The request ID.
Order	String	asc	The sort order.
TotalPage	Integer	20	The total number of pages.
PageSize	Integer	5	The number of entries per page.
TotalNum	Integer	12	The total number of entries that meet the specified conditions.
RecordIndexInfoList	Array of RecordIndexInfo		The index files.
RecordIndexInfo
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.
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	2015-12-01T07:46:00Z	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-01T07: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	HLS	The video format.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamRecordIndexFiles
&AppName=liveApp****
&DomainName=example.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&StreamName=liveStream****
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveStreamRecordIndexFilesResponse>
    <Order>asc</Order>
    <TotalNum>12</TotalNum>
    <TotalPage>20</TotalPage>
    <PageSize>5</PageSize>
    <PageNum>10</PageNum>
    <RequestId>DE24625C-7C0F-4020-8448-9C31A50C1556</RequestId>
    <RecordIndexInfoList>
        <RecordIndexInfo>
            <EndTime>2015-12-01T07:46:00Z</EndTime>
            <DomainName>example.com</DomainName>
            <CreateTime>2016-05-27T09:40:56Z</CreateTime>
            <StartTime>2015-12-01T07: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>
    </RecordIndexInfoList>
</DescribeLiveStreamRecordIndexFilesResponse>

JSON format

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

{
  "DescribeLiveStreamRecordIndexFilesResponse" : {
    "Order" : "asc",
    "TotalNum" : 12,
    "TotalPage" : 20,
    "PageSize" : 5,
    "PageNum" : 10,
    "RequestId" : "DE24625C-7C0F-4020-8448-9C31A50C1556",
    "RecordIndexInfoList" : {
      "RecordIndexInfo" : {
        "EndTime" : "2015-12-01T07:46:00Z",
        "DomainName" : "example.com",
        "CreateTime" : "2016-05-27T09:40:56Z",
        "StartTime" : "2015-12-01T07: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"
      }
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Check whether the value of the EndTime parameter matches.

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