DescribeLiveRecordVodConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

Obtain the streaming domain, and then call this operation to query the Live-to-VOD configurations.

QPS limit

You can call this operation up to 1,000 times per minute 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	DescribeLiveRecordVodConfigs	The operation that you want to perform. Set the value to DescribeLiveRecordVodConfigs.
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	Long	No	1	The page number. Default value: 1.
PageSize	Long	No	10	The number of entries per page. Valid values: 5 to 100. Default value: 10.

Response parameters

Parameter	Type	Example	Description
PageNum	Integer	1	The page number.
RequestId	String	5056369B-D337-499E-B8B7-B761BD37B08A	The request ID.
PageSize	Integer	1	The number of entries per page.
Total	String	100	The total number of entries returned.
LiveRecordVodConfigs	Array of LiveRecordVodConfig		The configurations.
LiveRecordVodConfig
StorageLocation	String	****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com	The storage location.
AppName	String	liveApp****	The name of the application to which the live stream belongs.
AutoCompose	String	ON	Indicates whether automatic merging is enabled. Valid values: ON OFF
OnDemand	Integer	0	Indicates whether on-demand recording is enabled. Valid values: 0 (default): On-demand recording is disabled. 1: On-demand recording is enabled by using the HTTP callback method.
StreamName	String	liveStream****	The name of the live stream.
CreateTime	String	2015-12-01T17:37:00Z	The time when the configuration was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
VodTranscodeGroupId	String	e2d796d3bb5fd8049d32bff62f94****	The ID of the transcoding template group in ApsaraVideo VOD.
CycleDuration	Integer	360	The recording cycle. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.
DomainName	String	example.com	The main streaming domain.
ComposeVodTranscodeGroupId	String	dadfcaadde****	The ID of the transcoding template group that was used to automatically merge the VOD files created from the live streams. Note This parameter is returned if the value of the AutoCompose parameter is ON.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveRecordVodConfigs
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&PageNum=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveRecordVodConfigsResponse>
    <PageNum>1</PageNum>
    <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
    <PageSize>1</PageSize>
    <Total>100</Total>
    <LiveRecordVodConfigs>
        <LiveRecordVodConfig>
            <StorageLocation>****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com</StorageLocation>
            <AppName>liveApp****</AppName>
            <AutoCompose>ON</AutoCompose>
            <OnDemand>0</OnDemand>
            <StreamName>liveStream****</StreamName>
            <CreateTime>2015-12-01T17:37:00Z</CreateTime>
            <VodTranscodeGroupId>e2d796d3bb5fd8049d32bff62f94****</VodTranscodeGroupId>
            <CycleDuration>360</CycleDuration>
            <DomainName>example.com</DomainName>
            <ComposeVodTranscodeGroupId>dadfcaadde****</ComposeVodTranscodeGroupId>
        </LiveRecordVodConfig>
    </LiveRecordVodConfigs>
</DescribeLiveRecordVodConfigsResponse>

JSON format

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

{
  "PageNum" : 1,
  "RequestId" : "5056369B-D337-499E-B8B7-B761BD37B08A",
  "PageSize" : 1,
  "Total" : 100,
  "LiveRecordVodConfigs" : {
    "LiveRecordVodConfig" : [ {
      "StorageLocation" : "****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com",
      "AppName" : "liveApp****",
      "AutoCompose" : "ON",
      "OnDemand" : 0,
      "StreamName" : "liveStream****",
      "CreateTime" : "2015-12-01T17:37:00Z",
      "VodTranscodeGroupId" : "e2d796d3bb5fd8049d32bff62f94****",
      "CycleDuration" : 360,
      "DomainName" : "example.com",
      "ComposeVodTranscodeGroupId" : "dadfcaadde****"
    } ]
  }
}

Error codes

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