直播按域名&流维度查询播放统计综合信息

最近更新时间:2021-04-10 09:43:37

查看PDF

GetLivePlayStatData

描述

本接口用于获取某个时间点的播放统计综合信息(5分钟粒度),包括域名维度和流维度的带宽、流量、在线人数,单位:带宽:bit/s,流量:byte,在线人数:个

  • 只需要设置起始时间,代表起始时间这5分钟的数据
  • 支持批量域名过滤查询
  • 最多可获取最近62天内的数据
  • 时效性:5-10分钟延迟
  • 本接口对应的数据每分钟更新一次,不适合过度频繁调用,每个UID限制访问频率300次/分钟
  • 本接口的域名维度数据支持HDL(HTTP-FLV)、RTMP、HLS协议,但流维度数据仅支持HDL(HTTP-FLV)、RTMP协议,不支持HLS协议。如果输入中含有HLS协议的域名,则HLS协议的域名仅返回域名维度数据,不返回流维度数据
  • 仅能返回在线人数Top1万的流记录。如果您的单域名下同时存在的流数量超过1万个,建议在应用场景上分域名处理,保障每个域名下同时存在的流数小于1万个
  • 由于域名维度的数据与流维度的数据计算方式不同,域名维度的数据与流维度的数据的加和,二者会有一定偏差
  • 只支持直播业务
  • 使用场景:
    • 客户查询一个单位时间(5分钟)内的直播总量数据、流维度数据,进行数据保存及数据分析

请求语法

本接口请求需要包含指定目录 /2016-09-01/statistics/GetLivePlayStatData和公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 是否必须 类型及范围 描述
StartTime Y String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:10+0800。注:如果您输入的起始时间不是5的倍数,则向小取值到5的倍数
DomainIds N String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions N String 区域名称,取值为CN:中国大陆,HK:中国香港,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲 ,支持多区域查询,多个区域用逗号(半角)分隔,缺省为CN
ResultType Y Int 取值为0:只返回域名维度的汇总数据;1:返回域名维度+流维度的详细数据
LimitN N Int 按在线人数排名的Top条数,取值为1-10000,最大10000,默认100

返回参数

参数名 类型及范围 描述
StartTime String 开始时间
DomainIds String 域名ID列表,逗号(半角)间隔
Regions String 区域,逗号(半角)间隔
ResultType Int 取值为0:只返回域名维度的汇总数据;1:返回域名维度+流维度的详细数据;
LimitN Int Top条数
Datas PlayStatDataByDomain[] 每个域名粒度的播放统计数据,域名维度

PlayStatDataByDomain

参数名 类型及范围 描述
DomainId String 域名Id
Bw Long 边缘带宽(该域名的总带宽,若选择多个区域,则返回该域名多个区域的数据合并值。该值和流维度数据求和会有一定误差),单位:bit/s
Flow Long 流量(该域名的总流量,若选择多个区域,则返回该域名多个区域的数据合并值。该值和流维度数据求和会有轻微误差),单位:byte
OnlineUser Long 在线人数(该域名的总在线人数。该值和流维度数据求和会有一定误差)
Streams PlayStatDataByStream[] 每个时间粒度的播放统计数据,流量维度。仅RTMP、HDL(HTTP-FLV)协议会返回流维度数据,HLS的流并不显示流维度数据(仅当StreamResultType取值为1时返回此数据)

PlayStatDataByStream

参数名 类型及范围 描述
StreamUrl String StreamUrl模式的URL形式的流名。
Bw Long 边缘带宽(该流名的边缘带宽,若选择多个区域,则返回该域名多个区域的数据合并值),单位:bit/s
Flow Long 流量(该流名的流量,若选择多个区域,则返回该域名多个区域的数据合并值),单位:byte
OnlineUser Long 在线人数

示例1:获取域名维度的汇总数据

请求示例

POST方式:

POST /2016-09-01/statistics/GetLivePlayStatData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetLivePlayStatData
x-version: 2016-09-01
Content-Type: application/GetLivePlayStatData
{
	"StartTime": "2018-06-20T16:14+0800",
	"ResultType": 0,
	"LimitN": 100
}

返回示例

JSON格式:

{
	"StartTime": "2018-06-20T16:19+0800",
	"DomainIds": "2D09FJS,2D09QS1,2D09FRV,2D09FRU,2D09QS0,2D09QS2",
	"Regions": "CN",
	"ResultType": 0,
	"LimitN": 1000,
	"Datas": [{
		"DomainId": "2D09QS2",
		"Bw": 920424,
		"Flow": 34516131,
		"OnlineUser": 2
	}]
}

示例2:获取域名维度+流维度的详细数据

请求示例

POST方式:

POST /2016-09-01/statistics/GetLivePlayStatData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetLivePlayStatData
x-version: 2016-09-01
Content-Type: application/GetLivePlayStatData
{
	"StartTime": "2018-06-20T16:14+0800",
	"ResultType": 1,
	"LimitN": 100
}

返回示例

JSON格式:

{
	"StartTime": "2018-06-20T16:14+0800",
	"DomainIds": "2D09FJS,2D09QS1,2D09FRV,2D09FRU,2D09QS0,2D09QS2",
	"Regions": "CN",
	"ResultType": 1,
	"LimitN": 1000,
	"Datas": [{
		"DomainId": "2D09QS2",
		"Bw": 1018784,
		"Flow": 38204663,
		"OnlineUser": 2,
		"Streams": [{
			"StreamUrl": "rtmp://videoqa.rtmplive.ks-cdn.com/qa-nice/pie-test-12f79bbb-12da-1c02-b12f-1b6cd0ef8f2d",
			"Bw": 537232,
			"Flow": 20146427,
			"OnlineUser": 1
		}, {
			"StreamUrl": "rtmp://videoqa.rtmplive.ks-cdn.com/qa-nice/pie-test-12f79bbb-12da-1c02-b12f-1b6cd0ef8f2d_h264",
			"Bw": 382856,
			"Flow": 14357315,
			"OnlineUser": 1
		}, {
			"StreamUrl": "rtmp://videoqa.rtmplive.ks-cdn.com/qa-nice/pie-test-34e43490-abab-4342-bd34-c0b65e34c2ac",
			"Bw": 64088,
			"Flow": 2403559,
			"OnlineUser": 0
		}, {
			"StreamUrl": "rtmp://videoqa.rtmplive.ks-cdn.com/qa-nice/pie-test-34e43490-abab-4342-bd34-c0b65e34c2ac_h264",
			"Bw": 34592,
			"Flow": 1297360,
			"OnlineUser": 0
		}]
	}]
}

错误码

下方为接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误代码(Code) 错误消息(Message) HTTP 状态码 中文描述(语义)
InvalidStartTime.Malformed Specified start time is malformed.StartTime:%s 400 StartTime格式错误
NoDataProvided We do not provide data more than 1 year. 400 所查询的时间范围超过限制
InvalidEndTime.Mismatch Specified end time should not be earlier than start time.StartTime:%s, EndTime:%s 400 EndTime不应早于StartTime
InvalidTime Start time with the time difference is not more than 62 days. 400 不支持查询62天前的数据
InvalidTime The start time and the end time difference is not more than 62 days. 400 所查询的时间跨度不能超过62天
InvalidRegion Invalid region.Expected:AF/AS/AU/CN/EU/NA/SA/HK/TW, but receive:%s 400 无效的区域名称
InvalidResultType Invalid result type.Expected:0/1, but receive:%s 400 无效的数据类型,应该为0/1
LimitNNumberOutOfRange Page number is out of range Expected:Between 1 and 10000, but receive:%s 400 limit超限
NoAvailableDomain No valid domain name was found according to the query criteria. 400 在当前查询条件下没发现目标域名
InvalidDomain.NotFound The domain provided does not belong to you or does not match the cdntype.Invalid domains:%s 400 直播业务不存在此域名
InvalidDomain.Offline The domain provided is offline.Offline domains:%s 400 所查询的域名已经停用
DomainCdnTypeNotMatch Domains and cdn type did not match.Invalid domains:%s 400 域名和域名类型不匹配
AccessDenied Access Denied.You are not authorized to perform:DomainIds:%s 403 权限不够,访问被拒绝

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

  • 内容不全,不深入
  • 内容更新不及时
  • 描述不清晰,比较混乱
  • 系统或功能太复杂,缺乏足够的引导
  • 内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈