Queries all index files within a specified period.

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 testApp

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

DomainName String Yes www.yourdomain.com

The streaming domain.

EndTime String Yes 2017-12-22T08:00:00Z

The end of the time range to query. The duration specified by the StartTime parameter and the EndTime parameter 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 testStream

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 rule used to sort entries. Valid values:

  • asc: The entries are sorted in ascending order. This is the default value.
  • desc: The entries are sorted in descending order.

Response parameters

Parameter Type Example Description
RecordIndexInfoList Array of RecordIndexInfo

The index files.

RecordIndexInfo
RecordUrl String http://****/atestObject.m3u8

The URL of the index file.

DomainName String www.yourdomain.com

The streaming domain.

AppName String testApp

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

StreamName String test123

The name of the live stream.

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

The start time of the recording. 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 time of the recording. 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 recording was created.

OssBucket String test123

The name of the Object Storage Service (OSS) bucket in which the recording is stored.

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of OSS.

OssObject String test123

The name of the recording that is stored in OSS.

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

The ID of the 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 rule used to sort entries.

TotalPage Integer 20

The total number of returned 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=testApp
&DomainName=www.yourdomain.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&StreamName=testStream
&<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>www.yourdomain.com</DomainName>
              <CreateTime>2016-05-27T09:40:56Z</CreateTime>
              <StartTime>2015-12-01T17:36:00Z</StartTime>
              <OssBucket>test123</OssBucket>
              <Duration>588.849</Duration>
              <AppName>testApp</AppName>
              <StreamName>test123</StreamName>
              <OssEndpoint>oss-cn-shanghai.aliyuncs.com</OssEndpoint>
              <RecordUrl>http://****/atestObject.m3u8</RecordUrl>
              <OssObject>test123</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.yourdomain.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 correct.
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 correct.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time is earlier than the start time. Check whether the values of the StartTime and EndTime parameters are correct.

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