DescribeLiveRecordVodConfigs-阿里云帮助中心

Queries live-to-VOD configurations of a streaming domain.

Operation description

QPS limit

This API is limited to 1,000 queries per minute for each account. If you exceed this limit, API calls are throttled, which can affect your business.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveRecordVodConfigs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	No	The AppName of the live stream.	liveApp****
StreamName	string	No	The stream name.	liveStream****
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 5 to 100.	10

Response elements

Element	Type	Description	Example
	object
PageNum	integer	The page number.	1
RequestId	string	The request ID.	5056369B-D337-499E-B8B7-B761BD37B08A
PageSize	integer	The page size.	1
Total	string	The total number of entries.	100
LiveRecordVodConfigs	object
LiveRecordVodConfig	array<object>	A list of live-to-VOD configurations.
	array<object>	A live-to-VOD configuration.
StorageLocation	string	The storage address.	****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com
AppName	string	The AppName of the live stream.	liveApp****
AutoCompose	string	Indicates whether automatic composition is enabled. Valid values: ON: enabled. OFF: disabled.	ON
OnDemand	integer	The trigger mode of live stream recording. Valid values: 0 (default): Automatic recording. 1: Triggered by callback notifications of on-demand recording. 2: Triggered by corresponding parameters in the stream ingest URL. 7: Triggered manually. By default, recording is disabled. You can call the `RealTimeRecordCommand` operation to manually start or stop recording.	0
StreamName	string	The stream name.	liveStream****
CreateTime	string	The creation time, in UTC. The time is formatted as yyyy-MM-ddTHH:mm:ssZ.	2015-12-01T17:37:00Z
VodTranscodeGroupId	string	The ID of the ApsaraVideo VOD transcoding template group for transcoding the recording files.	e2d796d3bb5fd8049d32bff62f94****
CycleDuration	integer	The maximum duration of each recording file. Unit: seconds. Default value: 3600. Range: 300 to 21600.	360
DomainName	string	The streaming domain.	example.com
ComposeVodTranscodeGroupId	string	The ID of the ApsaraVideo VOD transcoding template group for transcoding the composed video created by automatic composition. Note This parameter is returned only when `AutoCompose` is set to `ON`.	dadfcaadde****
RecordContent	string	The content to record. Valid values: `raw` (default): Records the source stream. `transcode`: Records the transcoded streams.	raw
DelayTime	integer	The reconnect timeout, in seconds. If a stream is interrupted but recovers within this window, the new content is automatically appended to the exisiting recording file. Otherwise, the previous session is considered ended, and a new recording file will be created. Valid values: 15 to 21600.	180
TranscodeTemplates	string	The transcoding templates configured in ApsaraVideo Live. It specifies which transcoded streams to record. A value of `*` indicates that all transcoded streams are recorded.	["sd","hd"]
FormatConfig	boolean	Specifies whether to enable format-specific configuration for VOD processing settings. The default value is true.	true
SpaceId	string	The ID of the ApsaraVideo VOD application space. You can find the ID in the ApsaraVideo VOD console or by calling the ListAppInfo operation. This parameter is required only if you have enabled application spaces.	app-1000000
RecordFormatList	object
RecordFormat	array<object>	A list of recording format configurations.
	object	A recording format configuration.
Format	string	The recording format.	m3u8
SliceDuration	integer	The duration of a TS segment, in seconds.	30
AutoCompose	string	Indicates whether automatic composition is enabled. ON: enabled. OFF: disabled.	ON
VideoProcess	string	The video to process. Valid values: `origin` (default): Processes the source recording files. `compose`: Processes the composed video.	origin
ProcessMethod	string	The video processing method. Valid values: `transcode`: Processes the video by using a transcoding template group set in ApsaraVideo VOD. `workflow`: Processes the video by using a workflow set in ApsaraVideo VOD.	transcode
ProcessTemplateId	string	The ID of the transcoding template group or workflow to use for video processing.	e2d796d3bb5fd8049d32bff62f94****
Tags	string	The video category.	sports

Examples

Success response

JSON format

{
  "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****",
        "RecordContent": "raw",
        "DelayTime": 180,
        "TranscodeTemplates": "[\"sd\",\"hd\"]",
        "FormatConfig": true,
        "SpaceId": "app-1000000",
        "RecordFormatList": {
          "RecordFormat": [
            {
              "Format": "m3u8",
              "SliceDuration": 30,
              "AutoCompose": "ON",
              "VideoProcess": "origin",
              "ProcessMethod": "transcode",
              "ProcessTemplateId": "e2d796d3bb5fd8049d32bff62f94****",
              "Tags": "sports"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.