Queries the information about all M3U8 index files within a specific time period.

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 15 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

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.

AppName String Yes liveApp****

The name of the application to which the live stream belongs.

DomainName String Yes www.example.com

The main streaming domain.

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.

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.

StreamName String Yes liveStream****

The name of the live stream.

PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.

Order String No asc

The sorting order. Valid values:

  • asc: sorts the entries in ascending order. This is the default value.
  • desc: sorts the entries in descending order.

Response parameters

Parameter Type Example Description
RecordIndexInfoList Array of RecordIndexInfo

The recording configurations of the queried M3U8 index files.

RecordIndexInfo
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.

StartTime String 2015-12-01T07:36:00Z

The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

EndTime String 2015-12-01T07:46:00Z

The end of the time range in which data was queried. 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.

OssBucket String liveBucket****

The name of the OSS bucket in which the M3U8 index file is stored.

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of OSS.

OssObject String liveObject****

The name of the recording that is stored in OSS.

RecordId String c4d7f0a4-b506-43f9-8de3-07732c3f****

The ID of the M3U8 index file.

PageNum Integer 10

The page number of the returned page.

PageSize Integer 5

The number of entries returned per page.

Order String asc

The sorting order.

TotalPage Integer 20

The total number of pages.

TotalNum Integer 12

The total number of entries that meet the specified conditions.

RequestId String DE24625C-7C0F-4020-8448-9C31A50C1556

The ID of the request.

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 

<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-01T17:36:00Z</EndTime>
              <DomainName>example.com</DomainName>
              <CreateTime>2016-05-27T09:40:56Z</CreateTime>
              <StartTime>2015-12-01T17:36:00Z</StartTime>
              <OssBucket>liveBucket****</OssBucket>
              <Duration>588.849</Duration>
              <AppName>liveApp****</AppName>
              <StreamName>liveStream****</StreamName>
              <OssEndpoint>oss-cn-shanghai.aliyuncs.com</OssEndpoint>
              <RecordUrl>http://****/atestObject.m3u8</RecordUrl>
              <OssObject>liveObject****</OssObject>
              <Height>480</Height>
              <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>
              <Width>640</Width>
        </RecordIndexInfo>
  </RecordIndexInfoList>
</DescribeLiveStreamRecordIndexFilesResponse>

JSON format 

{
    "Order": "asc",
    "TotalNum": "12",
    "TotalPage": "20",
    "PageSize": "5",
    "PageNum": "10",
    "RequestId": "DE24625C-7C0F-4020-8448-9C31A50C1556",
    "RecordIndexInfoList": {
        "RecordIndexInfo": [{
            "EndTime": "2015-12-01T17:36:00Z",
            "DomainName": "www.example.com",
            "CreateTime": "2016-05-27T09:40:56Z",
            "StartTime": "2015-12-01T17:36:00Z",
            "OssBucket": "test123",
            "Duration": "588.849",
            "AppName": "testApp",
            "StreamName": "test123",
            "OssEndpoint": "oss-cn-shanghai.aliyuncs.com",
            "RecordUrl": "http://****/atestObject.m3u8",
            "OssObject": "test123",
            "Height": "480",
            "RecordId": "c4d7f0a4-b506-43f9-8de3-07732c3f****",
            "Width": "640"
        }]
    }
}

Error codes

HTTP status code Error code Error message Description
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because 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 error message returned because 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 error message returned because the time range that is specified by the StartTime and EndTime parameters is invalid. Check whether the StartTime and EndTime parameters are correctly specified.

For a list of error codes, visit the API Error Center.