DescribeLiveStreamMerge - 查询主备合流配置

查询主备合流配置。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamMerge

get

*Domain

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

DomainName

string

播流域名。

example.com

AppName

string

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

app

StreamName

string

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

StreamName

Protocol

string

播流协议,取值:

  • rtmp(默认值)

  • rtc

rtmp

返回参数

名称

类型

描述

示例值

object

LiveStreamMergeList

object

LiveStreamMerge

array<object>

直播流信息列表。

object

直播流信息列表。

AppName

string

合流输出 App 名称。

app

AppUsing

string

当前使用的 App。

app1

DomainName

string

播流域名。

example.com

EndTime

string

合流结束时间。

2020-05-29T01:00:00Z

ExtraInAppStreams

string

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

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

InAppName1

string

合流输入主流应用名称。

app1

InAppName2

string

合流输入备流应用名称。

app2

InStreamName1

string

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

InStream1

InStreamName2

string

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

stream2

Protocol

string

直播流协议。

rtmp

StartTime

string

合流开始时间。

2020-05-29T00:00:00Z

StreamName

string

合流输出 Stream 名称。

StreamName

StreamUsing

string

当前使用的 Stream。

InStream1

LiveMerger

string

当前任务是否使用 merge 引擎。

on

MergeParameters

string

查询任务所对应的切流相关的配置参数

  1. 明确发生断流时(eof 或 net err),立刻触发主备切换;

  2. 最近 5 秒内卡顿率超过 60%,立刻触发主备切换;

  3. 拉流超时,持续 2 秒收不到帧数据,触发主备切换;

  4. 未断流、未发生卡顿,但是最近 ali_max_no_frame_timeout 时间内的平均帧率 小于 ali_low_frame_rate_threshold,立刻触发主备切换。如果用户设置了 ali_max_no_frame_timeout 参数,则 3 的超时时间会同步更新成 ali_max_no_frame_timeout。

开启 block_all_jitter 则 2、3、4 不生效。

取值范围:

  • 10 > ali_max_no_frame_timeout > 2;

  • 200 > ali_low_frame_rate_threshold > 1 ;

  • block_all_jitter 的值为 0(默认关闭)或 1(开启)。

ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0

RequestId

string

请求 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",
        "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"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParam Parameter invalid. 输入参数不合法
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.

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

变更历史

更多信息,参考变更详情