DescribeLiveStreamMerge - ApsaraVideo Live - Alibaba Cloud Documentation Center

Retrieves primary/backup stream merge configurations.

Operation description

This operation is limited to 100 queries per second (QPS) per user. If you exceed this limit, API calls are throttled. This may affect your business. We recommend that you call this operation within the specified limit.

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 AppName for the merged stream. View the AppName on the Primary/Backup Stream Merge page.	app
StreamName	string	No	The StreamName for the merged stream. View the StreamName on the Primary/Backup Stream Merge page.	StreamName
Protocol	string	No	The streaming protocol. Valid values: rtmp (default) rtc	rtmp

Response elements

Parameter	Type	Description	Example
	object
LiveStreamMergeList	object
LiveStreamMerge	array<object>	Live stream information.
	object	Live stream information.
AppName	string	The AppName for the merged stream.	app
AppUsing	string	The AppName of the currently active input stream.	app1
DomainName	string	The streaming domain.	example.com
EndTime	string	The end time of the stream merge.	2020-05-29T01:00:00Z
ExtraInAppStreams	string	The 3rd to Nth input streams for the merge.	app3/stream3,app4/stream4,app5/stream5,…,appN/streamN
InAppName1	string	The AppName of the primary input stream.	app1
InAppName2	string	The AppName of the backup input stream.	app2
InStreamName1	string	The StreamName of the primary input stream.	InStream1
InStreamName2	string	The StreamName of the backup input stream.	stream2
Protocol	string	The protocol of the input live streams.	rtmp
StartTime	string	The start time of the stream merge.	2020-05-29T00:00:00Z
StreamName	string	The StreamName for the merged stream.	StreamName
StreamUsing	string	The StreamName of the currently active input stream.	InStream1
LiveMerger	string	Indicates whether the liveswitch engine is used for the current task.	on
MergeParameters	string	The failover trigger conditions. Triggers: Explicit stream disconnection, such as EOF and network error. The stutter rate exceeds 60% within the last 5 seconds. No frame data is received for 2 seconds. The average frame rate drops below `ali_low_frame_rate_threshold` within the last `ali_max_no_frame_timeout` seconds, even without stuttering. If block_all_jitter is set to 1, Rules 2, 3, and 4 do not take effect. Valid values: ali_max_no_frame_timeout: (2,10) ali_low_frame_rate_threshold: (1,200). block_all_jitter: 0 or 1.	ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0
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"
      }
    ]
  },
  "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.