调用DescribeLiveStreamMonitorList查询监播室列表-视频直播-阿里云

查询已创建的监播室列表。

接口说明

先创建监播室后再调用本接口查询监播室列表，调用时请保证参数设置符合要求。

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamMonitorList

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
MonitorId	string	否	监播室 ID。说明通过查看 CreateLiveStreamMonitor 接口的返回参数获取 MonitorId 值。若参数为空，默认返回所有监播室合并后的数据。	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNum	integer	否	当前页数值。	2
PageSize	integer	否	每页监播室数值个数。	10
Status	integer	否	监播室内状态。取值： 1：监播中。 0：未监播。	1
OrderRule	integer	否	启动时间顺序。取值： 0：默认（按启动状态倒序，启动时间不参与排序）。 1：启动时间倒序。 2：启动时间正序。	1

返回参数

名称	类型	描述	示例值
	object
Total	integer	数量。	1
RequestId	string	请求 ID。	2234baba-a586-46ea-8bd4-c8f7891abcdef
LiveStreamMonitorList	array<object>	监播室列表。
	object
MonitorConfig	string	监播告警阈值设置。参数字段如下： fpsLowThres：视频帧率告警阈值，Float 类型。 brHighThres：音视频码率告警阈值，Float 类型。 eofDurationThresSec：断流时长检测阈值，Float 类型。	"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"
Status	integer	监播室内状态。取值： 1：监播中。 0：未监播。	1
MonitorId	string	监播室 ID。	445409ec-7eaa-461d-8f29-4bec2eb9****
Domain	string	监播输出域名。	demo.aliyundoc.com
CallbackUrl	string	监播告警通知回调地址。	http://guide.aliyundoc.com/notify
AudioFrom	integer	布局声音来源。	1
DingTalkWebHookUrl	string	钉群机器人 URL。	https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****
MonitorName	string	监播室名称。	liveMonito****
StopTime	string	停止监播时间，UTC 格式。	2017-01-11T12:00:00Z
StartTime	string	开始监播时间，UTC 格式。	2017-01-11T12:00:00Z
OutputTemplate	string	监播输出分辨率模板。类型取值： lp_ld：流畅。 lp_sd：标清。 lp_hd：高清。 lp_ud：超清。	lp_ud
Region	string	地区。取值： cn-shanghai：上海。 cn-beijing：北京。 ap-southeast-1：新加坡。	cn-shanghai
InputList	array<object>	监控流输入列表。
	object
Index	integer	索引，前端使用。	1
InputUrl	string	输入流地址。	demo.aliyundoc.com
LayoutId	integer	布局 ID，必须从 1 开始。	1
StreamName	string	监播流的显示名称。	monitorStream****
LayoutConfig	object	布局信息。
FillMode	string	填充类型，前端填 none 即可。	none
PositionRefer	string	设置元素的 position 参考坐标值，取值： topLeft topRight bottomLeft bottomRight	topLeft
PositionNormalized	array	位置归一化值[unk][x,y][unk]，默认为[unk][0,0][unk]。>x，y 需要进行归一化计算。
	number	表示该 Layer 元素填充区位置[x,y]，x 和 y 归一化百分比。例如[0.1,0.1]代表左上角水平偏移 10%, 垂直偏移 10%。	0.1
SizeNormalized	array	字幕文件大小，单位为字节。
	number	Layer 元素需要填充的尺寸大小[w,h]，w 和 h 归一化百分比。例如[0.2,0.3]代表水平占比 20%，垂直占比 30%。	0.3
PlayConfig	object	播放配置。
VolumeRate	number	音量。取值 0~1 之间，精确小数点后 2 位。	0.50
OutputUrls	object	监播输出地址。
FlvUrl	string	FLV 输出地址。	http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv
RtmpUrl	string	RTMP 输出地址。	rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****

示例

正常返回示例

JSON格式

{
  "Total": 1,
  "RequestId": "2234baba-a586-46ea-8bd4-c8f7891abcdef",
  "LiveStreamMonitorList": [
    {
      "MonitorConfig": "\"{\\\"fpsLowThres\\\": 0.6,\\\"brLowThres\\\": 1.1,\\\"eofDurationThresSec\\\": 10}\"",
      "Status": 1,
      "MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "Domain": "demo.aliyundoc.com",
      "CallbackUrl": "http://guide.aliyundoc.com/notify",
      "AudioFrom": 1,
      "DingTalkWebHookUrl": "https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****",
      "MonitorName": "liveMonito****",
      "StopTime": "2017-01-11T12:00:00Z",
      "StartTime": "2017-01-11T12:00:00Z",
      "OutputTemplate": "lp_ud",
      "Region": "cn-shanghai",
      "InputList": [
        {
          "Index": 1,
          "InputUrl": "demo.aliyundoc.com",
          "LayoutId": 1,
          "StreamName": "monitorStream****",
          "LayoutConfig": {
            "FillMode": "none",
            "PositionRefer": "topLeft",
            "PositionNormalized": [
              0.1
            ],
            "SizeNormalized": [
              0.3
            ]
          },
          "PlayConfig": {
            "VolumeRate": 0.5
          }
        }
      ],
      "OutputUrls": {
        "FlvUrl": "http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv",
        "RtmpUrl": "rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****"
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	InvalidUserId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s

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

变更历史

更多信息，参考变更详情。