DescribeLiveStreamMetricDetailData - 查询指定域名流粒度批量数据

调用DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据，单次查询最多返回5000行数据。

接口说明

若指定域名第一次使用此接口进行流粒度数据的查询，需先提交工单进行后端配置后方可使用。请在工单中提供如下信息：

需要查询的域名。
对应域名下最高并发直播流数。
每个直播流最高并发在线人数。
对应客户端请求包含的协议类型。

重要

当前接口将于 2025 年 9 月 31 号不再进行维护，请及时切换到新版流粒度接口 DescribeLiveUserStreamMetricData ，新版流粒度接口无需后台配置即可使用。

使用限制

默认不支持 HLS 的在线人数统计。
仅支持单个域名查询。
数据最大查询跨度：24 小时。
数据最小查询粒度：1 分钟。
数据最大查询范围：31 天。

QPS 限制

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamMetricDetailData

none

*Domain

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shenzhen
DomainName	string	否	需要查询的加速域名。仅支持单个域名查询，传多个域名将报错。不指定 AppName 和 StreamName 时，按域名返回所有流粒度的数据。域名为空时，查询用户下的所有加速域名的聚合数据 DomainName 不为空且 AppName 为 all 和 StreamName 为 all 时，返回指定加速域名下的聚合数据。传入 DomainName 时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。	example.com
StartTime	string	是	获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2015-12-10T20:00:00Z
EndTime	string	是	结束时间需大于起始时间，不能相差超过 1 天；日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2015-12-10T21:00:00Z
AppName	string	否	应用名称，查询指定应用流粒度的数据。说明指定 StreamName 时，必须指定 AppName。	liveApp****
StreamName	string	否	流名称，按照设置的 AppName 指定 StreamName，返回流粒度的数据。说明指定 StreamName 时，必须指定 AppName。	liveStream****
Protocol	string	否	流协议名，目前支持：flv、hls、rtmp、rts 和 p2p。支持查询多个协议的数据，不同协议之间用英文逗号（,）分隔。但多个协议的数据不会聚合，按照流的粒度输出。说明 rts 选项可查询 artc 协议的超低延时直播流。使用 rts 可能需要额外统计 xxx_AliRTS-opu 转码流。原因：Web 端播超低延时直播时，会生成流名后加上_AliRTS-opus 后缀的转码流进行自动转码，产生转码流数据。详细请参见 rts 亚秒延时自动转码。	flv
NextPageToken	string	否	分页查询 token，每次查询最多返回 5000 行数据，当要查询的数据超过 5000 行时，响应数据会提供下次查询数据的起始索引。请求时传入该 token，将从上一次查询结束的下一行继续查询未获取的数据。	UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

返回参数

名称	类型	描述	示例值
	object	查询数据。
DomainName	string	查询的加速域名。	example.com
EndTime	string	结束时间。	2015-12-10T21:00:00Z
NextPageToken	string	下一次返回数据的起始索引，当查询的数据未获取完时返回该值。	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	返回数据行数。	5000
RequestId	string	请求 ID。	B955107D-E658-4E77-B913-E0AC3D31693E
StartTime	string	开始时间。	2015-12-10T20:00:00Z
StreamDetailData	object
StreamData	array<object>	返回数据组。
	object	返回数据组。
AppName	string	应用名称。	app
Bps	number	流每分钟平均带宽，单位：bps。	423304182.66
Count	integer	流每分钟总在线人数。	423304182
FlvBps	number	FLV 协议带宽，单位：bps。说明指定协议不满足时，不返回。	454
FlvCount	integer	FLV 协议在线人数。说明指定协议不满足时，不返回。	32
FlvTraffic	integer	FLV 协议流量，单位：Byte。说明指定协议不满足时，不返回。	1254
HlsBps	number	HLS 协议带宽，单位：bps。说明指定协议不满足时，不返回。	4456
HlsCount	integer	HLS 协议在线人数。说明目前不支持。	56
HlsTraffic	integer	HLS 协议流量，单位：Byte。说明指定协议不满足时，不返回。	568
NewConns	string	流每分钟新建连接数。	450
P2pBps	number	P2P 协议带宽，单位：bps。说明指定协议不满足时，不返回.	6845
P2pCount	integer	P2P 协议在线人数。说明指定协议不满足时，不返回。	78
P2pTraffic	integer	P2P 协议流量，单位：Byte。说明指定协议不满足时，不返回。	4102
RtmpBps	number	RTMP 协议带宽，单位：bps。说明指定协议不满足时，不返回。	3323
RtmpCount	integer	RTMP 协议在线人数。说明指定协议不满足时，不返回。	63
RtmpTraffic	integer	RTMP 协议流量，单位：Byte。说明指定协议不满足时，不返回。	5568
RtsBps	number	RTS 协议带宽，单位：bps。说明指定协议不满足时，不返回。	2361
RtsCount	integer	RTS 协议在线人数。说明指定协议不满足时，不返回。	89
RtsTraffic	integer	RTS 协议流量，单位：Byte。说明指定协议不满足时，不返回。	2322
StreamName	string	流名称。	test.flv
TimeStamp	string	时间片起始时刻。	2015-12-10T20:00:00Z
Traffic	integer	流每分钟总流量，单位：Byte。	423304182

示例

正常返回示例

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "app",
        "Bps": 423304182.66,
        "Count": 423304182,
        "FlvBps": 454,
        "FlvCount": 32,
        "FlvTraffic": 1254,
        "HlsBps": 4456,
        "HlsCount": 56,
        "HlsTraffic": 568,
        "NewConns": "450",
        "P2pBps": 6845,
        "P2pCount": 78,
        "P2pTraffic": 4102,
        "RtmpBps": 3323,
        "RtmpCount": 63,
        "RtmpTraffic": 5568,
        "RtsBps": 2361,
        "RtsCount": 89,
        "RtsTraffic": 2322,
        "StreamName": "test.flv",
        "TimeStamp": "2015-12-10T20:00:00Z",
        "Traffic": 423304182
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	结束时间与开始时间不匹配，请您确认时间的匹配度。
400	InvalidTimeSpan	The time span exceeds the limit.	时间跨度超过限制，请参照接口文档，配置合理查询跨度。
400	InvalidPageToken	The token of page is invalid.	指定的分页token错误，请传入上次查询返回的正确索引，并确认没有修改您的请求参数。
400	InvalidAppName.Mismatch	The AppName param must be passed.	AppName参数不匹配，请确认传入了正确的AppName参数。
400	InvalidStreamProtocol.NotSupport	The specified stream protocol is not support.	指定的流协议不支持，请参照文档查询所需的流协议。
400	InvalidStreamName.LengthTooLong	The specified stream name is too long.	StreamName的长度超过限制，请传入合法的StreamName。
400	InvalidAppName.LengthTooLong	The specified app name is too long.	AppName的长度超过限制，请传入合法的AppName。
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	指定的时间无效。

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

变更历史

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