Queries the configurations of the Live to VOD feature.

Usage note

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 1000 queries per minute. 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 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 number of the page to return. Default value: 1.

PageSize Long No 10

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

Response parameters

Parameter Type Example Description
LiveRecordVodConfigs Array of LiveRecordVodConfig

The configurations of the Live to VOD feature.
LiveRecordVodConfig
AppName String liveApp****

The name of the application to which the live stream belongs.
AutoCompose String ON

Indicates whether video-on-demand (VOD) files created from the live streams are automatically merged. Valid values:

  • ON: The VOD files are automatically merged.
  • OFF: The VOD files are not automatically merged.
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 AutoCompose parameter is set to ON.
CreateTime String 2015-12-01T17:37:00Z

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

CycleDuration Integer 360

The duration of the periodically recorded video. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.

DomainName String example.com

The main streaming domain.
StreamName String liveStream****

The name of the live stream.
VodTranscodeGroupId String e2d796d3bb5fd8049d32bff62f94****

The ID of the transcoding template group.
PageNum Integer 1

The page number of the returned page.
PageSize Integer 1

The number of entries returned per page.
RequestId String 5056369B-D337-499E-B8B7-B761BD37B08A

The ID of the request.
Total String 100

The total number of returned entries.

Examples

Sample requests

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

Sample success responses

XML format 

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

JSON format 

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

Error codes

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