All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamRecordIndexFiles

Last Updated:Dec 12, 2024

Queries all index files within a specific time period.

Operation description

  • ApsaraVideo Live stores the information about M3U8 index files for six months. You can query the information about only the M3U8 index files that were 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamRecordIndexFilesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

Usage notes

  • ApsaraVideo Live stores the information about an M3U8 index file for six months. You can query only the information of index files created in the previous six months.
  • M3U8 index files are stored in Object Storage Service (OSS) buckets. The retention period is determined by the storage configuration of the OSS buckets.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

example.com
AppNamestringYes

System-defined parameter. Value: DescribeLiveStreamRecordIndexFiles.

liveApp****
StreamNamestringYes

The main streaming domain.

liveStream****
StartTimestringYes

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

2017-12-21T08:00:00Z
EndTimestringYes

The name of the live stream.

2017-12-22T08:00:00Z
PageNumintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 5 to 30. Default value: 10.

10
OrderstringNo

The order in which the entries are sorted based on creation time. Valid values:

  • asc (default): ascending order
  • desc: descending order
asc

Response parameters

ParameterTypeDescriptionExample
object
PageNuminteger

The page number.

10
RequestIdstring

The request ID.

DE24625C-7C0F-4020-8448-9C31A50C1556
Orderstring

The sort order.

asc
TotalPageinteger

The total number of pages.

20
PageSizeinteger

The number of entries per page.

5
TotalNuminteger

The total number of entries that meet the specified conditions.

12
RecordIndexInfoListarray<object>

The index files.

RecordIndexInfoobject
RecordUrlstring

The URL of the index file.

http://****/atestObject****.m3u8
StreamNamestring

The name of the live stream.

liveStream****
CreateTimestring

The time when the index file was created.

2016-05-27T09:40:56Z
RecordIdstring

The ID of the index file.

c4d7f0a4-b506-43f9-8de3-07732c3f****
Heightinteger

The video height.

480
OssBucketstring

The name of the Object Storage Service (OSS) bucket.

liveBucket****
DomainNamestring

The main streaming domain.

example.com
OssObjectstring

The name of the storage file in OSS.

liveObject****
EndTimestring

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.

2015-12-01T07:46:00Z
AppNamestring

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

liveApp****
StartTimestring

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.

2015-12-01T07:36:00Z
Widthinteger

The video width.

640
Durationfloat

The recording length. Unit: seconds.

588.849
OssEndpointstring

The endpoint of the OSS bucket.

cn-oss-****.aliyuncs.com
Formatstring

The video format.

HLS

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.-
400InvalidEndTime.MalformedSpecified EndTime is malformed.-
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.The end time does not match the start time. Make sure that the start and end times match.
400InvalidStartTime.MismatchSpecified StartTime does not math the current time.-
400ForbiddenRam Permission is forbidden.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-25The Error code has changed. The response structure of the API has changedView Change Details