DescribeLiveStreamMerge - 查询主备合流配置

调用DescribeLiveStreamMerge查询主备合流配置。

接口说明

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveStreamMergeget
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

播流域名。

example.com
AppNamestring

合流输出 App 名称。您可在主备合流配置页面查看。

app
StreamNamestring

合流输出 Stream 名称。您可在主备合流配置页面查看。

StreamName
Protocolstring

播流协议,取值:

  • rtmp(默认值)

  • rtc

rtmp

返回参数

名称类型描述示例值
object
LiveStreamMergeListarray<object>

直播流信息列表。

LiveStreamMergeobject

直播流信息列表。

AppNamestring

合流输出 App 名称。

app
AppUsingstring

当前使用的 App。

app1
DomainNamestring

播流域名。

example.com
EndTimestring

合流结束时间。

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

合流输入第 3 路-第 N 路的 app 和 stream。

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

合流输入主流应用名称。

app1
InAppName2string

合流输入备流应用名称。

app2
InStreamName1string

合流输入主流直播流名称。

InStream1
InStreamName2string

合流输入备流直播流名称。

stream2
Protocolstring

直播流协议。

rtmp
StartTimestring

合流开始时间。

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

合流输出 Stream 名称。

StreamName
StreamUsingstring

当前使用的 Stream。

InStream1
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamParameter invalid.输入参数不合法
400QuotaExceeded.MergeExceed max merge count limit-
400ConfigAlreadyExistsConfig has already exist.配置已添加。
500InternalErrorThe request processing has failed due to backend service exception.-

访问错误中心查看更多错误码。