DescribeLiveDomainOnlineUserNum - 查询域名下所有流某分钟的在线人数信息

查询域名下所有流的在线人数信息。

接口说明

本接口目前只支持 FLV、RTS 和 RTMP 播放在线人数统计，暂不支持 HLS 播放在线人数统计。数据采集和统计有一定延迟，建议您查询 5 分钟前的数据。

说明

请使用本接口替换原有的 DescribeLiveStreamOnlineUserNum（已废弃）接口。

QPS 限制

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveDomainOnlineUserNum

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
DomainName	string	是	主播流域名。	example.com
QueryTime	string	否	查询的时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2018-12-27T13:09:21Z

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	3A3A8C3D-F8B2-4FBF-9319-771A11B855FA
UserCount	integer	查询时间下域名的所有在线人数。	1
StreamCount	integer	流数。	1
OnlineUserInfo	object
LiveStreamOnlineUserNumInfo	array<object>	流的信息。
	object
StreamName	string	流名称。	rtmp://example.com/test/liveStream****_3_1
Infos	object
Info	array<object>	流统计信息。
	object
UserNumber	integer	转码流或原始流的人数	1
TranscodeTemplate	string	转码模板。origin 为原始流。	origin

示例

正常返回示例

JSON格式

{
  "RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
  "UserCount": 1,
  "StreamCount": 1,
  "OnlineUserInfo": {
    "LiveStreamOnlineUserNumInfo": [
      {
        "StreamName": "rtmp://example.com/test/liveStream****_3_1",
        "Infos": {
          "Info": [
            {
              "UserNumber": 1,
              "TranscodeTemplate": "origin"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InternalError	The request processing has failed due to backend service exception.
400	InvalidQueryTime.Exceed	QueryTime exceed three month.	查询时间距离当前时间超过三个月。
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.	指定的查询时间无效。

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

变更历史

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