DescribeLiveRecordVodConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries live-to-VOD configurations.

Operation description

After you obtain the streaming domain, you can call this operation to query the list of configurations for converting live streams to VOD.

QPS limit

The limit for this operation is 1,000 queries per second (QPS) per user. If you exceed the limit, API calls are throttled. This may impact your business. We recommend that you plan your calls accordingly.

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 name of the stream.	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

Parameter	Type	Description	Example
	object
PageNum	integer	The page number.	1
RequestId	string	The request ID.	5056369B-D337-499E-B8B7-B761BD37B08A
PageSize	integer	The number of entries per page.	1
Total	string	The total number of entries.	100
LiveRecordVodConfigs	object
LiveRecordVodConfig	array<object>	The list of configurations.
	object
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	Indicates whether on-demand recording is enabled. Valid values: 0 (default): disabled. 1: On-demand recording is enabled using HTTP callbacks.	0
StreamName	string	The stream name.	liveStream****
CreateTime	string	The time when the configuration was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2015-12-01T17:37:00Z
VodTranscodeGroupId	string	The ID of the ApsaraVideo VOD transcoding template group.	e2d796d3bb5fd8049d32bff62f94****
CycleDuration	integer	The recording duration for each file. Unit: seconds. The default value is 3600. Valid values: 300 to 21600.	360
DomainName	string	The streaming domain.	example.com
ComposeVodTranscodeGroupId	string	The ID of the ApsaraVideo VOD transcoding template group that is used to transcode the the single, composed video file that is generated after automatic composition. Note This parameter is returned if AutoCompose is set to ON.	dadfcaadde****

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****"
      }
    ]
  }
}

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.