All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamRecordIndexFiles

更新時間:Nov 21, 2024

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

Operation description

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.

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

1
PageSizeintegerNo

The end of the time range to query. The maximum time range to query is 4 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

10
OrderstringNo

The page number. Default value: 1.

Enumeration Value:
  • asc
  • desc
asc

Response parameters

ParameterTypeDescriptionExample
object
PageNuminteger

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

10
RequestIdstring

The sorting order of the index files by creation time. Valid values:

  • asc (default): ascending order.
  • desc: descending order.
DE24625C-7C0F-4020-8448-9C31A50C1556
Orderstring

The page number.

asc
TotalPageinteger

The request ID.

20
PageSizeinteger

The sorting order.

5
TotalNuminteger

The total number of pages.

12
RecordIndexInfoListarray<object>

The number of entries per page.

RecordIndexInfoobject
RecordUrlstring

The total number of entries returned.

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

The configurations of the M3U8 index files.

liveStream****
CreateTimestring

The URL of the M3U8 index file.

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

The name of the live stream.

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

The time when the M3U8 index file was created.

480
OssBucketstring

The ID of the M3U8 index file.

liveBucket****
DomainNamestring

The height of the video.

example.com
OssObjectstring

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

liveObject****
EndTimestring

The main streaming domain.

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

The name of the recording that is stored in OSS.

liveApp****
StartTimestring

The end of the time range of the M3U8 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 name of the application to which the live stream belongs.

640
Durationfloat

The beginning of the time range of the M3U8 index file. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

588.849
OssEndpointstring

The width of the video.

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

The recording length. Unit: seconds.

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