All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveStreamRecordIndexFile

    Document Center

    ApsaraVideo Live:DescribeLiveStreamRecordIndexFile

    Last Updated:Dec 16, 2025

    Queries the information about an index file.

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

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    live:DescribeLiveStreamRecordIndexFile

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    Yes

    Usage notes

    ApsaraVideo Live stores the configuration information of an M3U8 index file for six months. You can query only 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 100 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
    AppName

    string

    Yes

    System-defined parameter. Value: DescribeLiveStreamRecordIndexFile.

    liveApp****
    StreamName

    string

    Yes

    The main domain of the live stream.

    liveStream****
    RecordId

    string

    Yes

    The ID of the index file.

    Note

    You can call the DescribeLiveStreamRecordIndexFiles operation to query the ID.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    5EBF2AC3-4B73-40A5-8B32-83F49D5F035E
    RecordIndexInfo

    object

    The information about the index file.

    RecordUrl

    string

    The URL of the index file.

    http://****/atestObject****.m3u8
    StreamName

    string

    The name of the live stream.

    liveStream****
    CreateTime

    string

    The time when the index file was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

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

    string

    The ID of the index file.

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

    integer

    The video height.

    480
    OssBucket

    string

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

    liveBucket****
    DomainName

    string

    The main streaming domain.

    example.com
    OssObject

    string

    The name of the storage file in OSS.

    liveObject****
    EndTime

    string

    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.

    2016-05-25T05:47:11Z
    AppName

    string

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

    liveApp****
    StartTime

    string

    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-01T05:36:00Z
    Width

    integer

    The video width.

    640
    Duration

    number

    The recording length. Unit: seconds.

    588.849
    OssEndpoint

    string

    The endpoint of the OSS bucket.

    cn-oss-****.aliyuncs.com
    Format

    string

    The video format.

    mp4

    Examples

    Success response

    JSON format

    {
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "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": "2016-05-25T05:47:11Z",
    "AppName": "liveApp****",
    "StartTime": "2015-12-01T05:36:00Z",
    "Width": 640,
    "Duration": 588.849,
    "OssEndpoint": "cn-oss-****.aliyuncs.com",
    "Format": "mp4"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.