All Products
Search
Document Center

:DescribeLiveStreamMerge

Last Updated:Dec 05, 2024

Invoke DescribeLiveStreamMerge to query the primary-standby stream merging configuration.

Operation description

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamMergeget
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The streaming domain.

example.com
AppNamestringNo

The name of the application that generates the output stream. You can view the application name on the Primary/Secondary Stream Mixing Settings page of the ApsaraVideo Live console.

app
StreamNamestringNo

The name of the output stream. You can view the stream name on the Primary/Secondary Stream Mixing Settings page of the ApsaraVideo Live console.

StreamName
ProtocolstringNo

The streaming protocol. Valid values:

  • rtmp: This is the default value.
  • rtc
rtmp

Response parameters

ParameterTypeDescriptionExample
object
LiveStreamMergeListarray<object>

Live stream information list.

LiveStreamMergeobject

Live streaming information list.

AppNamestring

The name of the application that generates the output stream.

app
AppUsingstring

The application that is being used.

app1
DomainNamestring

The streaming domain.

example.com
EndTimestring

The end time of the stream mixing.

2020-05-29T01:00:00Z
ExtraInAppStreamsstring

The names of the applications that generate the input additional streams other than the primary stream and secondary stream, and the names of these additional streams.

app3/stream3,app4/stream4,app5/stream5,…,appN/streamN
InAppName1string

The name of the application that generates the input primary stream.

app1
InAppName2string

The name of the application that generates the input secondary stream.

app2
InStreamName1string

The name of the input primary stream.

InStream1
InStreamName2string

The name of the input secondary stream.

stream2
Protocolstring

The streaming protocol.

rtmp
StartTimestring

The start time of the stream mixing.

2020-05-29T00:00:00Z
StreamNamestring

The name of the output stream.

StreamName
StreamUsingstring

The stream that is being used.

InStream1
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  },
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamParameter invalid.Illegal input parameters
400QuotaExceeded.MergeExceed max merge count limit-
400ConfigAlreadyExistsConfig has already exist.-
500InternalErrorThe request processing has failed due to backend service exception.-

For a list of error codes, visit the Service error codes.