文档

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

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

使用说明

若指定域名第一次使用此接口进行流粒度数据的查询,需先提交工单进行后端配置后方可使用。

请在工单中提供如下信息:

  • 需要查询的域名。
  • 对应域名下最高并发直播流数。
  • 每个直播流最高并发在线人数。
说明 提交工单申请后预计在一个工作日内完成审核。

使用限制

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

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveStreamMetricDetailData

系统规定参数。取值:DescribeLiveStreamMetricDetailData

DomainName String example.com
  • 需要查询的加速域名。仅支持单个域名查询,传多个域名将报错。
  • 不指定AppName和StreamName时,按域名返回所有流粒度的数据。
  • 域名为空时,查询用户下的所有加速域名的聚合数据
  • DomainName不为空且AppName为all和StreamName为all时,返回指定加速域名下的聚合数据。
StartTime String 2015-12-10T20:00:00Z

获取数据起始时间点,日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

EndTime String 2015-12-10T21:00:00Z

结束时间需大于起始时间,不能相差超过1天;日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

AppName String liveApp****

应用名称,查询指定应用流粒度的数据。

说明 指定StreamName时,必须指定AppName。
StreamName String liveStream****

流名称,按照设置的AppName指定StreamName,返回流粒度的数据。

说明 指定StreamName时,必须指定AppName。
Protocol String flv

流协议名,目前支持:flvhlsrtmprtsp2p

支持查询多个协议的数据,不同协议之间用英文逗号(,)分隔。但多个协议的数据不会聚合,按照流的粒度输出。

NextPageToken String UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

分页查询token,每次查询最多返回5000行数据,当要查询的数据超过5000行时,响应数据会提供下次查询数据的起始索引。请求时传入该token,将从上一次查询结束的下一行继续查询未获取的数据。

返回数据

名称

类型

示例值

描述

DomainName String example.com

查询的加速域名。

EndTime String 2015-12-10T21:00:00Z

结束时间。

NextPageToken String UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

下一次返回数据的起始索引,当查询的数据未获取完时返回该值。

PageSize Integer 5000

返回数据行数。

RequestId String B955107D-E658-4E77-B913-E0AC3D31693E

请求ID。

StartTime String 2015-12-10T20:00:00Z

开始时间。

StreamDetailData Array of StreamData

返回数据组。

StreamData
AppName String app

应用名称。

Bps Float 423304182.66

流每分钟平均带宽,单位:bps。

Count Long 423304182

流每分钟总在线人数。

FlvBps Float 454

FLV协议带宽,单位:bps。

说明 指定协议不满足时,不返回。
FlvCount Long 32

FLV协议在线人数。

说明 指定协议不满足时,不返回。
FlvTraffic Long 1254

FLV协议流量,单位:Byte。

说明 指定协议不满足时,不返回。
HlsBps Float 4456

HLS协议带宽,单位:bps。

说明 指定协议不满足时,不返回。
HlsCount Long 56

HLS协议在线人数。

说明 指定协议不满足时,不返回。
HlsTraffic Long 568

HLS协议流量,单位:Byte。

说明 指定协议不满足时,不返回。
NewConns String 450

流每分钟新建连接数。

P2pBps Float 6845

P2P协议带宽,单位:bps。

说明 指定协议不满足时,不返回.
P2pCount Long 78

P2P协议在线人数。

说明 指定协议不满足时,不返回。
P2pTraffic Long 4102

P2P协议流量,单位:Byte。

说明 指定协议不满足时,不返回。
RtmpBps Float 3323

RTMP协议带宽,单位:bps。

说明 指定协议不满足时,不返回。
RtmpCount Long 63

RTMP协议在线人数。

说明 指定协议不满足时,不返回。
RtmpTraffic Long 5568

RTMP协议流量,单位:Byte。

说明 指定协议不满足时,不返回。
RtsBps Float 2361

RTS协议带宽,单位:bps。

说明 指定协议不满足时,不返回。
RtsCount Long 89

RTS协议在线人数。

说明 指定协议不满足时,不返回。
RtsTraffic Long 2322

RTS协议流量,单位:Byte。

说明 指定协议不满足时,不返回。
StreamName String test.flv

流名称。

TimeStamp String 2015-12-10T20:00:00Z

时间片起始时刻。

Traffic Long 423304182

流每分钟总流量,单位:Byte。

示例

请求示例

http(s)://live.aliyuncs.com?Action=DescribeLiveStreamMetricDetailData
&DomainName=example.com  
&StartTime=2015-12-10T20:00:00Z  
&EndTime=2015-12-10T21:00:00Z  
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode

错误码

错误信息

描述

400 InvalidStartTime.Malformed Specified StartTime is malformed. StartTime参数错误,请您确认该StartTime参数是否正确。
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. 开始时间和结束时间不匹配。

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