1.接口描述
- 接口
Get_LiveStat:查询指定直播流的推流和播放信息。
Get_LivePushStat :仅返回推流统计信息以提高查询效率。
Get_LivePlayStat :仅返回播放统计信息以提高查询效率。
- 地址
API 调用地址为: http://statcgi.video.qcloud.com/common_access
。
- 用途
查询某条直播流的统计信息(如观看人数、带宽、码率、帧率等)。
查询当前正在直播状态中的若干条直播流的统计信息(建议采用分页查询避免单次回包数据过大)。
- 说明
统计数据均为查询时间点的瞬时统计数据,而并非历史累计数据。
如果目标流不在直播中,则返回结果中的 output
字段为空。
推流信息的统计数据每5秒钟更新一次,无需以快于5s的频率进行查询。
播放信息的统计数据每1分钟更新一次,无需以快于60s的频率进行查询。
- BETA
统计接口目前尚处于 Beta 阶段,并未全员放开,未开通即调用此接口会收到【cmd is invalid】提示,如您急需请联系我们。
2.输入参数
参数名 |
参数含义 |
类型 |
备注 |
是否必需 |
cmd |
客户 ID |
int |
即直播 APPID,用于区分不同客户的身份 |
Y |
interface |
接口名称 |
string |
如:Get_LivePushStat |
Y |
t |
有效时间 |
int |
UNIX 时间戳(十进制) |
Y |
sign |
安全签名 |
string |
MD5(key+t) |
Y |
Param.n.page_no |
分页页码 |
int |
从1开始,默认为1 |
N |
Param.n.page_size |
分页大小 |
int |
1 - 300,默认为300 |
N |
Param.s.stream_id |
直播码 |
string |
如不设置 stream_id:查询所有正在直播中的流 |
N |
Param.s.pull_domain |
拉流域名 |
string |
即播放域名,如果不填则返回所有域名的播放数据 |
N |
Param.s.push_domain |
推流域名 |
string |
推流域名,如果不填,查询所有推流域名下的流列表 |
N |
3.输出结果
Get_LiveStat
参数名 |
参数含义 |
类型 |
备注 |
ret |
返回码 |
int |
0:成功;其他值:失败 |
message |
错误信息 |
string |
错误信息 |
output |
消息内容 |
array |
详情见下 |
其中 output 的主要内容为:
字段名 |
含义 |
类型 |
备注 |
stream_count |
所有在线的直播流数量 |
int |
- |
stream_info |
直播流统计信息 |
array |
详情见下 |
total_bandwidth |
当前账号在查询时间点的总带宽 |
double |
单位:Mbps |
total_online |
当前账号在查询时间点的在线人数 |
int |
单位:人 |
其中 stream_info 的主要内容为:
字段名 |
含义 |
类型 |
备注 |
stream_name |
直播码 |
string |
- |
bandwidth |
该直播流的瞬时带宽占用 |
double |
单位:Mbps |
online |
该直播流的瞬时在线人数 |
int |
单位:人 |
client_ip |
推流客户端 IP |
string |
- |
server_ip |
接流服务器 IP |
string |
- |
fps |
瞬时推流帧率 |
int |
- |
speed |
瞬时推流码率 |
int |
bps |
Get_LivePushStat
Get_LivePushStat 的 output 部分是 Get_LiveStat 的一个子集:
字段名 |
含义 |
类型 |
备注 |
stream_count |
所有在线的直播流数量 |
int |
- |
stream_info |
直播流统计信息 |
array |
详情见下 |
其中 stream_info 的主要内容为:
字段名 |
含义 |
类型 |
备注 |
stream_name |
直播码 |
string |
- |
client_ip |
推流客户端 IP |
string |
- |
server_ip |
接流服务器 IP |
string |
- |
fps |
瞬时推流帧率 |
int |
- |
speed |
瞬时推流码率 |
int |
bps |
Get_LivePlayStat
Get_LivePlayStat 的 output 部分是 Get_LiveStat 的另一个子集:
字段名 |
含义 |
类型 |
备注 |
stream_count |
所有在线的直播流数量 |
int |
- |
stream_info |
直播流统计信息 |
array |
详情见下 |
total_bandwidth |
当前账号在查询时间点的总带宽 |
double |
单位:Mbps |
total_online |
当前账号在查询时间点的并发连接数 |
int |
单位:人 |
其中 stream_info 的主要内容为:
字段名 |
含义 |
类型 |
备注 |
stream_name |
直播码 |
string |
- |
bandwidth |
该直播流的瞬时带宽占用 |
double |
单位:Mbps |
online |
该直播流的瞬时并发连接数 |
int |
单位:人 |
4.调用示例
目标:查询当前账户名下所有正在直播的视频流的推流和播放信息。
组成部分 |
示例内容 |
接口 URL |
http://statcgi.video.qcloud.com/common_access? |
cmd |
1234 |
interface |
Get_LiveStat |
Param.n.page_no |
1 |
Param.n.page_size |
20 |
t |
1471850187 |
sign |
b17971b51ba0fe5916ddcd96692e9fb3 |
URL = http:
cmd=1234&interface=Get_LiveStat
&Param.n.page_no=1
&Param.n.page_size=20
&t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3