All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveStreamRecordContent

    Document Center

    ApsaraVideo Live:DescribeLiveStreamRecordContent

    Last Updated:Jul 23, 2024

    Queries the recordings of a live stream.

    Usage notes

    Obtain the main streaming domain, and then call this operation to query the recordings of the live stream.

    This operation allows you to query the recordings that are generated by a recording task. If you want to query the information about all index files within a specific time period, call the DescribeLiveStreamRecordIndexFiles operation. If you want to query the information about a single index file, call the DescribeLiveStreamRecordIndexFile operation.

    QPS limit

    You can call this operation up to 50 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. For more information, see QPS limits.

    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

    DescribeLiveStreamRecordContent

    The operation that you want to perform. Set the value to DescribeLiveStreamRecordContent.

    DomainName

    String

    Yes

    example.com

    The main streaming domain.

    AppName

    String

    Yes

    liveApp****

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

    StreamName

    String

    Yes

    liveStream****

    The name of the live stream.

    StartTime

    String

    Yes

    2017-12-21T08:00:00Z

    The beginning of the time range to query. You can query only the recordings in the last 6 months. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    EndTime

    String

    Yes

    2017-12-22T08:00:00Z

    The end of the time range to query. The maximum time range that can be specified by the StartTime and EndTime parameters 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.

    Response parameters

    Parameter

    Type

    Example

    Description

    RequestId

    String

    62136AE6-7793-45ED-B14A-60D19A9486D3

    The request ID.

    RecordContentInfoList

    Array of RecordContentInfo

    The recordings.

    RecordContentInfo

    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.

    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.

    Duration

    Float

    10

    The recording length. Unit: seconds.

    OssBucket

    String

    liveBucket****

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

    OssObjectPrefix

    String

    record/{Date}/{UnixTimestamp}_{Sequence}

    The naming rule of the recording stored in OSS.

    OssEndpoint

    String

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

    The endpoint of the OSS bucket.

    Note

    For information about the URLs used to access OSS resources, see How do I obtain the URL of a single object or the URLs of multiple objects?

    Examples

    Sample requests

    http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamRecordContent
&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

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamRecordContentResponse>
<RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>
<RecordContentInfoList>
    <RecordContentInfo>
        <EndTime>2015-12-01T07:46:00Z</EndTime>
        <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
        <StartTime>2015-12-01T07:36:00Z</StartTime>
        <OssBucket>liveBucket****</OssBucket>
        <Duration>10</Duration>
        <OssObjectPrefix>record/{Date}/{UnixTimestamp}_{Sequence}</OssObjectPrefix>
    </RecordContentInfo>
</RecordContentInfoList>
</DescribeLiveStreamRecordContentResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveStreamRecordContentResponse" : {
    "RequestId" : "62136AE6-7793-45ED-B14A-60D19A9486D3",
    "RecordContentInfoList" : {
      "RecordContentInfo" : {
        "EndTime" : "2015-12-01T07:46:00Z",
        "OssEndpoint" : "cn-oss-****.aliyuncs.com",
        "StartTime" : "2015-12-01T07:36:00Z",
        "OssBucket" : "liveBucket****",
        "Duration" : 10,
        "OssObjectPrefix" : "record/{Date}/{UnixTimestamp}_{Sequence}"
      }
    }
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    InvalidStartTime.Malformed

    Specified StartTime is malformed.

    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 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 end time does not match the start time. Check whether the value of the EndTime parameter matches.

    For a list of error codes, see Service error codes.