Live Stream Merge Configuration Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the primary and backup stream merging configurations.

Operation description

The queries per second (QPS) limit for a single user is 100. If the limit is exceeded, API calls are throttled, which may affect your services. Call this API operation at a reasonable frequency.

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:DescribeLiveStreamMerge

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

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 name of the application for the merged stream output. You can view it on the Primary and backup stream merging configurations page.	app
StreamName	string	No	The name of the stream for the merged stream output. You can view it on the Primary and backup stream merging configurations page.	StreamName
Protocol	string	No	The streaming protocol. Valid values: rtmp (default) rtc	rtmp

Response elements

Element	Type	Description	Example
	object
LiveStreamMergeList	object
LiveStreamMerge	array<object>	The list of live streams.
	object	The list of live streams.
AppName	string	The name of the application for the merged stream output.	app
AppUsing	string	The application currently in use.	app1
DomainName	string	The streaming domain.	example.com
EndTime	string	The end time of the stream merging. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2020-05-29T01:00:00Z
ExtraInAppStreams	string	The applications and streams for the third to Nth input streams of the merged stream.	app3/stream3,app4/stream4,app5/stream5,…,appN/streamN
InAppName1	string	The name of the application for the primary input stream of the merged stream.	app1
InAppName2	string	The name of the application for the backup input stream of the merged stream.	app2
InStreamName1	string	The name of the primary input live stream for the merged stream.	InStream1
InStreamName2	string	The name of the backup input live stream for the merged stream.	stream2
Protocol	string	The live stream protocol.	rtmp
StartTime	string	The start time of the stream merging. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2020-05-29T00:00:00Z
StreamName	string	The name of the stream for the merged stream output.	StreamName
StreamUsing	string	The stream currently in use.	InStream1
LiveMerger	string	Indicates whether the current task uses the merge engine. Valid values: off : off on : on	on
MergeParameters	string	The configuration parameters related to stream switching for the queried task. When a stream interruption occurs (EOF or network error), a primary/backup switchover is immediately triggered. If the stuttering rate exceeds 60% within the last 5 seconds, a primary/backup switchover is immediately triggered. If stream pulling times out and no frame data is received for 2 consecutive seconds, a primary/backup switchover is triggered. If the stream is not interrupted and no stuttering occurs, but the average frame rate within the recent ali_max_no_frame_timeout period is less than ali_low_frame_rate_threshold, a primary/backup switchover is immediately triggered. If the ali_max_no_frame_timeout parameter is set, the timeout period in condition 3 is updated to the value of ali_max_no_frame_timeout. If block_all_jitter is enabled, conditions 2, 3, and 4 do not take effect. Valid values: 10 > ali_max_no_frame_timeout > 2 200 > ali_low_frame_rate_threshold > 1 The value of block_all_jitter is 0 (disabled by default) or 1 (enabled).	ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0
SwitchMode	string	The switching mode for primary and backup stream merging. Valid values: manually and automatically.	manually
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "LiveStreamMergeList": {
    "LiveStreamMerge": [
      {
        "AppName": "app",
        "AppUsing": "app1",
        "DomainName": "example.com",
        "EndTime": "2020-05-29T01:00:00Z",
        "ExtraInAppStreams": "app3/stream3,app4/stream4,app5/stream5,…,appN/streamN",
        "InAppName1": "app1",
        "InAppName2": "app2",
        "InStreamName1": "InStream1",
        "InStreamName2": "stream2",
        "Protocol": "rtmp",
        "StartTime": "2020-05-29T00:00:00Z",
        "StreamName": "StreamName",
        "StreamUsing": "InStream1",
        "LiveMerger": "on",
        "MergeParameters": "ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0\n",
        "SwitchMode": "manually"
      }
    ]
  },
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	QuotaExceeded.Merge	Exceed max merge count limit
400	ConfigAlreadyExists	Config has already exist.
500	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.