用于查询指定加速域名下的流粒度批量数据,支持多种协议。
接口说明
暂不支持 HLS 协议新建连接数查询,HLS 在线人数按照默认格式的请求进行统计,特殊格式的请求需提交工单进行配置。默认格式如下:
m3u8 请求示例:http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8
ts 请求示例:http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts
请求说明
单次查询限制:单次查询最多返回 5000 行数据。
域名查询限制:仅支持单个域名查询,多个域名会报错。
时间跨度限制:数据最大查询跨度为 24 小时。
时间粒度限制:数据最小查询粒度为 1 分钟。
查询范围限制:数据最大查询范围为 31 天。
调用频率限制:单用户调用频率为 10 次/秒。
特殊参数组合:当
DomainName
不为空且AppName
和StreamName
都设置为all
时,将返回加速域名下的聚合数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:DescribeLiveUserStreamMetricData |
none |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DomainName |
string |
否 |
需要查询的加速域名。 说明
仅支持单个域名查询,传多个域名将报错。域名为空时,查询用户下的所有加速域名的聚合数据。不指定 |
test.com |
StartTime |
string |
是 |
获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为: |
2015-12-10T20:00:00Z |
EndTime |
string |
是 |
结束时间需大于起始时间,不能相差超过 1 天;日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为: |
2015-12-10T21:00:00Z |
AppName |
string |
否 |
应用名称。指定应用名称,查询对应应用流粒度的数据;指定 |
app |
StreamName |
string |
否 |
流名称。指定 |
test.flv |
Protocol |
string |
否 |
流协议名。指定流协议名查询流对应协议的数据,目前支持: 说明
rts 选项可查询 artc 协议的超低延时直播流。
|
flv |
PageNumber |
integer |
是 |
当前页码。 |
1 |
PageSize |
integer |
是 |
单页数据条数,单页最大 5000 |
10 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
Schema of Response |
||
DomainName |
string |
加速域名信息 |
test.com |
EndTime |
string |
YYYY-MM-DDThh:mm:ssZ |
2015-12-10T21:00:00Z |
PageSize |
integer |
每页显示的条数。 |
10 |
RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F**** |
StartTime |
string |
获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为: |
2015-12-10T20:00:00Z |
StreamDetailData |
array<object> |
每个时间间隔的流量数据 |
|
object |
返回数据组。 |
||
AppName |
string |
应用名称,无论是否指定均返回该值 |
app |
Bps |
number |
流每分钟总带宽,单位 |
423304182.66 |
Count |
integer |
流每分钟总在线人数 |
423304182 |
FlvBps |
number |
flv 协议带宽,单位 bps (指定协议不满足时,不返回) |
454 |
FlvCount |
integer |
flv 协议在线人数(指定协议不满足时,不返回) |
32 |
FlvTraffic |
number |
flv 协议流量,单位 byte (指定协议不满足时,不返回) |
1254 |
HlsBps |
number |
hls 协议带宽,单位 bps (指定协议不满足时,不返回) |
4456 |
HlsCount |
integer |
hls 协议在线人数 (指定协议不满足时,不返回) |
56 |
HlsTraffic |
number |
hls 协议流量,单位 byte (指定协议不满足时,不返回) |
568 |
NewConns |
integer |
流每分钟新建连接数 |
450 |
P2pBps |
number |
p2p 协议带宽,单位 bps (指定协议不满足时,不返回) |
6845 |
P2pCount |
integer |
p2p 协议在线人数 (指定协议不满足时,不返回) |
78 |
P2pTraffic |
number |
p2p 协议流量,单位 byte (指定协议不满足时,不返回) |
4102 |
RtmpBps |
number |
rtmp 协议带宽,单位 bps (指定协议不满足时,不返回) |
3323 |
RtmpCount |
integer |
rtmp 协议在线人数(指定协议不满足时,不返回) |
63 |
RtmpTraffic |
number |
rtmp 协议流量,单位 byte (指定协议不满足时,不返回) |
5568 |
RtsBps |
number |
rts 协议带宽,单位 bps (指定协议不满足时,不返回) |
2361 |
RtsCount |
integer |
rts 协议在线人数 (指定协议不满足时,不返回) |
89 |
RtsTraffic |
number |
rts 协议流量,单位 byte (指定协议不满足时,不返回) |
2322 |
StreamName |
string |
流名称,无论是否指定均返回该值 |
test.flv |
TimeStamp |
string |
时间片起始时刻 |
2015-12-10T20:00:00Z |
Traffic |
number |
流每分钟总流量,单位 byte |
423304182 |
TotalCount |
integer |
总条数 |
50 |
PageNumber |
integer |
页码 |
1 |
示例
正常返回示例
JSON
格式
{
"DomainName": "test.com",
"EndTime": "2015-12-10T21:00:00Z",
"PageSize": 10,
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
"StartTime": "2015-12-10T20:00:00Z",
"StreamDetailData": [
{
"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
}
],
"TotalCount": 50,
"PageNumber": 1
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | Meter.ParamError | Param Error:%s,Please Check Again. | 报错信息 |
500 | Meter.ServerInternalError | The Request Processing Has Failed Due To Some Unknown Error. | 服务内部异常 |
500 | Meter.DataSourceQueryError | Data Source Error:%s,Please Try Again. | 数据查询错误 |
403 | Meter.AuthError | Authentication Failed,Please Try Again. | 鉴权失败 |
502 | Meter.ReadyTsError | Get ReadyTs Failed,Please Try Again. | 查询的数据还未就绪 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。