Queries the recording configurations of all applications under a streaming domain name.

Usage note

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 100 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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 DescribeLiveRecordConfig

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

DomainName String Yes example.com

The main streaming domain.

AppName String No liveApp****

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

StreamName String No liveStream****

The name of the live stream.

PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 5

The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.

Order String No asc

The rule that is used to sort entries. Valid values:

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

Response parameters

Parameter Type Example Description
RequestId String 5056369B-D337-499E-B8B7-B761BD37B08A

The ID of the request.

LiveAppRecordList Array of LiveAppRecord

The list of recording configurations.

LiveAppRecord
DomainName String example.com

The main streaming domain.

AppName String liveApp****

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

OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of Object Storage Service (OSS).

OssBucket String liveBucket****

The name of the OSS bucket in which recordings are stored.
CreateTime String 2016-05-20T09:33:38Z

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

RecordFormatList Array of RecordFormat

The format list of recordings.

RecordFormat
Format String M3U8

The format of the recording.

OssObjectPrefix String record/{AppName}/{StreamName}

The name of the recording.

SliceOssObjectPrefix String record/{AppName}/{StreamName}/{UnixTimestamp}

The name of the segment file.

CycleDuration Integer 3600

The duration of the recording. Unit: seconds.

SliceDuration Integer 30

The duration of a single segment file in the transcoded stream recording. Unit: seconds.

EndTime String 2018-11-08T03:49:18Z

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.

OnDemond Integer 0

Indicates whether on-demand recording is enabled. Valid values:

  • 0: disables on-demand recording.
  • 1: enables on-demand recording by using the HTTP callback method.
  • 2: enables on-demand recording by setting the ingest parameters.
  • 7: By default, ApsaraVideo Live does not automatically record live streams. You can call the RealTimeRecordCommand operation to manually start or stop recording.
Note If you set the OnDemand parameter to 1, you must call the AddLiveRecordNotifyConfig operation to configure the OnDemandUrl parameter. Otherwise, ApsaraVideo Live does not perform on-demand recording.
StartTime String 2018-11-08T02:49:18Z

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.

StreamName String liveStream****

The name of the live stream.

TranscodeRecordFormatList Array of RecordFormat

The format list of the transcoded stream recordings.

RecordFormat
CycleDuration Integer 3600

The duration of the recording. Unit: seconds.

Format String m3u8

The format of the transcoded stream recording.

OssObjectPrefix String record/{AppName}/{StreamName}

The name of the transcoded stream recording.

SliceDuration Integer 30

The duration of a single segment file in the transcoded stream recording. Unit: seconds.

SliceOssObjectPrefix String record/{AppName}/{StreamName}/{UnixTimestamp}

The name of the segment file in the transcoded stream recording.

TranscodeTemplates List ["sd","hd"]

The transcoding template of the transcoded stream. If all transcoded streams are recorded, ["*"] is returned.

PageNum Integer 5

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

Order String desc

The rule that is used to sort entries.

TotalPage Integer 20

The total number of returned pages.

TotalNum Integer 12

The total number of recording configurations that meet the specified conditions.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveRecordConfig
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveRecordConfigResponse>
      <LiveAppRecordList>
            <LiveAppRecord>
                  <AppName>liveApp****</AppName>
                  <CreateTime>2016-05-20T09:33:38Z</CreateTime>
                  <DomainName>example.com</DomainName>
                  <FormatList>
                        <Format>
                              <Name>m3u8</Name>
                              <OssObjectPrefix>record/{AppName}/{StreamName}</OssObjectPrefix>
                              <SliceOssObjectPrefix>record/{AppName}/{StreamName}/{UnixTimestamp}</SliceOssObjectPrefix>
                        </Format>
                  </FormatList>
                  <OssBucket>liveBucket****</OssBucket>
                  <OssEndpoint>oss-cn-hangzhou.aliyuncs.com</OssEndpoint>
            </LiveAppRecord>
      </LiveAppRecordList>
      <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
</DescribeLiveRecordConfigResponse>

JSON format 

{
    "LiveAppRecordList":{
        "LiveAppRecord":[{
            "AppName":"liveApp****",
            "CreateTime":"2016-05-20T09:33:38Z",
            "DomainName":"example.com",
            "FormatList":{
                "Format":[{
                    "Name":"m3u8",
                    "OssObjectPrefix":"record/{AppName}/{StreamName}",
                    "SliceOssObjectPrefix":"record/{AppName}/{StreamName}/{UnixTimestamp}"
                }]
            },
            "OssBucket":"liveBucket****",
            "OssEndpoint":"oss-cn-hangzhou.aliyuncs.com"
        }]
    },
    "RequestId":"5056369B-D337-499E-B8B7-B761BD37B08A"
}

Error Codes

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