Usage notes

Obtain the main streaming domain, and then call this operation to query the recording configurations of all applications under the main streaming domain.

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. For more information, 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 page number. Default value: 1.
PageSize	Integer	No	5	The number of entries per page. Valid values: 5 to 30. Default value: 10.
Order	String	No	asc	The sorting order. Valid values: asc (default): ascending order desc: descending order

Response parameters

Parameter	Type	Example	Description
PageNum	Integer	5	The page number.
RequestId	String	5056369B-D337-499E-B8B7-B761BD37B08A	The request ID.
Order	String	desc	The sorting order.
TotalPage	Integer	20	The total number of pages returned.
PageSize	Integer	10	The number of entries per page.
TotalNum	Integer	12	The total number of recording configurations that meet the specified conditions.
LiveAppRecordList	Array of LiveAppRecord		The list of recording configurations.
LiveAppRecord
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.
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.
AppName	String	liveApp****	The name of the application to which the live stream belongs.
StreamName	String	liveStream****	The name of the live stream.
DelayTime	Integer	180	The interruption duration for merge. If the stream interruption duration exceeds the specified duration, a new recording is generated. The value of this parameter ranges from 15 to 21600.
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.
OnDemond	Integer	0	Indicates how on-demand recording is configured. 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 stream 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 need to call the AddLiveRecordNotifyConfig operation to configure the OnDemandUrl parameter. Otherwise, ApsaraVideo Live does not perform on-demand recording.
OssBucket	String	liveBucket****	The name of the Object Storage Service (OSS) bucket.
DomainName	String	example.com	The main streaming domain.
OssEndpoint	String	cn-oss-****.aliyuncs.com	The endpoint of the OSS bucket.
RecordFormatList	Array of RecordFormat		The format settings.
RecordFormat
SliceDuration	Integer	30	The duration of a single segment in the transcoded stream recording. Unit: seconds.
CycleDuration	Integer	3600	The recording duration. Unit: seconds.
SliceOssObjectPrefix	String	record/{liveApp**}/{liveStream**}/{UnixTimestamp}	The name of the segment.
OssObjectPrefix	String	record/{liveApp**}/{liveStream**}	The name of the recording.
Format	String	M3U8	The recording format.
TranscodeRecordFormatList	Array of RecordFormat		The format settings of a transcoded stream.
RecordFormat
SliceDuration	Integer	30	The duration of a single segment in the transcoded stream recording. Unit: seconds.
CycleDuration	Integer	3600	The recording duration. Unit: seconds.
SliceOssObjectPrefix	String	record/{liveApp**}/{liveStream**}/{UnixTimestamp}	The name of the segment in the transcoded stream.
OssObjectPrefix	String	record/{liveApp**}/{liveStream**}	The name of the transcoded stream recording.
Format	String	M3U8	The format of the transcoded stream recording.
TranscodeTemplates	Array of String	["sd","hd"]	The transcoding template of the transcoded stream. If all transcoded streams are recorded, ["*"] is returned.

Examples

Sample requests

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

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveRecordConfigResponse>
<Order>desc</Order>
<TotalNum>12</TotalNum>
<TotalPage>20</TotalPage>
<PageSize>10</PageSize>
<PageNum>5</PageNum>
<RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
<LiveAppRecordList>
    <LiveAppRecord>
        <StreamName>liveStream****</StreamName>
        <EndTime>2018-11-08T03:49:18Z</EndTime>
        <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
        <DomainName>example.com</DomainName>
        <CreateTime>2016-05-20T09:33:38Z</CreateTime>
        <StartTime>2018-11-08T02:49:18Z</StartTime>
        <OssBucket>liveBucket****</OssBucket>
        <OnDemond>0</OnDemond>
        <AppName>liveApp****</AppName>
        <RecordFormatList>
            <RecordFormat>
                <Format>M3U8</Format>
                <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>
                <CycleDuration>3600</CycleDuration>
                <SliceDuration>30</SliceDuration>
                <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>
            </RecordFormat>
        </RecordFormatList>
        <TranscodeRecordFormatList>
            <RecordFormat>
                <Format>M3U8</Format>
                <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>
                <CycleDuration>3600</CycleDuration>
                <SliceDuration>30</SliceDuration>
                <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>
            </RecordFormat>
        </TranscodeRecordFormatList>
        <TranscodeTemplates>
            <Templates>["sd","hd"]</Templates>
        </TranscodeTemplates>
    </LiveAppRecord>
</LiveAppRecordList>
</DescribeLiveRecordConfigResponse>

JSON format

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

{
  "DescribeLiveRecordConfigResponse" : {
    "Order" : "desc",
    "TotalNum" : 12,
    "TotalPage" : 20,
    "PageSize" : 10,
    "PageNum" : 5,
    "RequestId" : "5056369B-D337-499E-B8B7-B761BD37B08A",
    "LiveAppRecordList" : {
      "LiveAppRecord" : {
        "StreamName" : "liveStream****",
        "EndTime" : "2018-11-08T03:49:18Z",
        "OssEndpoint" : "cn-oss-****.aliyuncs.com",
        "DomainName" : "example.com",
        "CreateTime" : "2016-05-20T09:33:38Z",
        "StartTime" : "2018-11-08T02:49:18Z",
        "OssBucket" : "liveBucket****",
        "OnDemond" : 0,
        "AppName" : "liveApp****",
        "RecordFormatList" : {
          "RecordFormat" : {
            "Format" : "M3U8",
            "SliceOssObjectPrefix" : "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
            "CycleDuration" : 3600,
            "SliceDuration" : 30,
            "OssObjectPrefix" : "record/{liveApp****}/{liveStream****}"
          }
        },
        "TranscodeRecordFormatList" : {
          "RecordFormat" : {
            "Format" : "M3U8",
            "SliceOssObjectPrefix" : "record/{liveApp****}/{liveStream****}/{UnixTimestamp}",
            "CycleDuration" : 3600,
            "SliceDuration" : 30,
            "OssObjectPrefix" : "record/{liveApp****}/{liveStream****}"
          }
        },
        "TranscodeTemplates" : {
          "Templates" : "[\"sd\",\"hd\"]"
        }
      }
    }
  }
}

Error codes

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