UpdateLiveStreamMonitor - 更新监播室

更新监播室配置。

接口说明

此接口针对监播室配置进行更新,监播室在启动状态下对输入源配置更新可实时生效。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

监播室 ID。

说明 通过查看 CreateLiveStreamMonitor 接口的返回参数获取 MonitorId 值。
445409ec-7eaa-461d-8f29-4bec2eb9****
MonitorNamestring

监播室名称。

liveMonitor****
Domainstring

监播输出域名。

demo.aliyundoc.com
Appstring

监播输出流的 App。 名称可自取,不传默认用 monitor 作为 AppName 名称。

monitor****
Streamstring

监播输出流名。

monitorStream****
OutputTemplatestring

监播输出模版。类型取值:

  • lp_ld:流畅。
  • lp_sd:标清。
  • lp_hd:高清。
  • lp_ud:超清。
lp_ud
InputListstring

监控流输入列表。具体内容,请参考下表 InputConfig

InputConfig
MonitorConfigstring

监播告警阈值设置,JSON 格式,具体内容,请参考下表 MonitorConfig。

"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"
CallbackUrlstring

支持输入 HTTP(S)格式的回调地址。

http://guide.aliyundoc.com/notify
DingTalkWebHookUrlstring

监播钉钉告警通过钉群机器人进行告警信息的通知,请先设置钉群机器人,并在此输入机器人的 HTTP(S)地址。详情请参见自定义机器人接入

说明 配置钉群机器人自定义关键词为“告警”,否则消息无法接收。
https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****

InputConfig

名称类型描述示例值
IndexInteger索引,前端使用。1
LayoutIdInteger布局 ID,必须从 1 开始。1
StreamNameString监播流的显示名称。monitorStream****
InputUrlString输入流地址。demo.aliyundoc.com
LayoutConfigLayoutConfig布局信息。参考下表 LayoutConfig
PlayConfigPlayConfig播放配置。参考下表 PlayConfig

LayoutConfig

名称类型描述示例值
FillModeString填充类型,前端填 none 即可。none
PositionReferString设置元素的 position 参考坐标值,取值:TopLeft(左上),TopRight(右上),BottomLeft(左下),BottomRight(右下)。TopLeft
PositionNormalizedFloat表示该 Layer 元素填充区位置归一化值[x,y]。
x 和 y 的取值范围为 0~1。
例如[0.1,0.1] 代表左上角水平偏移 10%, 垂直偏移 10%。
[0.1, 0.1]
SizeNormalizedFloat表示该 Layer 元素需要填充的尺寸大小[w,h]。
w 和 h 取值范围为 0~1,宽高都是进行了归一化计算。
例如 [0.2,0.3]代表水平占比 20%,垂直占比 30%。
[0.2, 0.3]

PlayConfig

名称类型描述示例值
VolumeRateFloat音量。取值 0~1 之间,精确小数点后 2 位。0.50

MonitorConfig

名称类型描述示例值
fpsLowThresFloat视频帧率告警阈值。此阈值为比例系数,取值范围(0.0,1.0],默认值 0.7。当监播流的视频帧率<帧率告警阈值*直播流原始帧率,则会报警。0.7
brHighThresFloat音视频码率告警阈值。此阈值为比例系数,取值范围(0.0,100],默认值 1.0。当监播流的音视频码率>码率告警阈值*直播流原始码率,则会报警。1.0
eofDurationThresSecFloat断流时长检测阈值,表示当前监播流断流超过多少时间(单位:秒)才会报警。取值范围(0,65535],默认值 0。 - 由于断流后连接不断,系统会有内部收包超时时间(5 秒)来判断断流。因此如果设置此参数时间<=5s,实际检测时间仍为 5s;如果设置该项时间>5s,实际检测时间为设置值,只是前 5s 为内部收包超时,剩余时间为持续等待流没有恢复时间。 - 如果断流后没达到此超时时间流自动恢复,则不会报警。如果断流未超时,此时修改了监播地址,对前流也不会继续检测超时和报警。10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5c6a2a0d-f228-4a64-af62-20e91b9676b3

示例

正常返回示例

JSON格式

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

错误码

HTTP status code错误码错误信息
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400MissingParameter%s
400InvalidMonitorId.Malformed%s
401IllegalOperation%s
404InvalidDomainName.NotFound%s
404StreamMonitorNotExist%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
2024-09-04OpenAPI 错误码发生变更查看变更详情