接口功能介绍
支持按照协议、运营商、省份、流名等不同维度查询直播带宽。
使用说明
单个用户一分钟限制调用10000次,并发不超过100。
可查询历史数据时间范围为最近14天。
单次可查询的时间跨度为3小时,时间延时为5分钟。
单次查询输入域名的个数不能超过100个。
最大返回记录50000条记录。
该接口查询的数据不作为计费依据。
接口详情
请求方式:post
请求路径:/live/statistics/query-bandwidth-data
请求参数
参数名 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
start_time | long | 开始时间戳 | 是 | 起始时间,时间戳(秒)。不传或者传小于等于0是默认取当前时间-3分钟 |
end_time | long | 结束时间戳 | 是 | 结束时间,时间戳(秒)。不传或者传小于等于0默认取start_time + 1分钟 |
interval | string | 时间粒度 | 否 | 时间粒度,目前限制1m,不传默认1m |
domain | list(string) | 域名列表 | 否 | 域名,不传默认名下所有域名,可多个域名,且域名的个数不超过100个 |
app | list(string) | 应用名列表 | 否 | 应用名,默认名下所有应用名,可多个应用名 |
stream | list(string) | 流名列表 | 否 | 流名,默认名下所有流名,可多个流名 |
province | list(int) | 省编码列表 | 否 | 省编码列表,不传默认所有省份,点击查看省份及对应的省编码。 |
isp | list(string) | 运营商编码列表 | 否 | 运营商编码,不传默认所有运营商,可多个运营商编码,作为统计筛选项,点击查看运营商及对应的运营商编码。 |
protocol | list(string) | 应用层协议列表 | 否 | 应用层协议,不传默认所有络层协议,支持作为统计筛选项,可以为rtmp、http、https |
live_type | list(string) | 播放协议列表 | 否 | 播放协议,支持rtmp,flv,hls,other,不传默认所有播放协议,作为统计过滤项。 |
group_by | list(string) | 聚合维度 | 否 | 该指标统计结果的聚合维度,支持在时间颗粒度外叠加多种聚合维度。目前支持domain,app,province,isp,stream,province,isp,protocol,live_type。不传默认统计结果按时间颗粒维度聚合。 |
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
message | string | 描述信息 |
start_time | int | 开始时间戳 |
end_time | int | 结束时间戳 |
interval | string | 时间粒度 |
req_bandwidth_data_interval | list | 每个时间间隔的在线人数 |
req_bandwidth_data_interval [*].time_stamp | int | 时间片开始时间戳 |
req_bandwidth_data_interval [*].domain | string | 域名 |
req_bandwidth_data_interval [*].app | string | 应用名 |
req_bandwidth_data_interval [*].stream | string | 流名 |
req_bandwidth_data_interval [*].province | int | 省编码 |
req_bandwidth_data_interval [*].isp | string | 运营商编码 |
req_bandwidth_data_interval [*].protocol | string | 应用层协议 |
req_bandwidth_data_interval[*].live_type | string | 直播协议类型 |
req_bandwidth_data_interval [*].bandwidth | long | 带宽,单位为bps |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/statistics/query-bandwidth-data
请求示例
{
"start_time": 1655704800,
"end_time": 1655712000,
"interval": "1m",
"domain": [
"ctyun.cn"
],
"app": [
"live875"
],
"stream": [
"testlive1655708999875"
],
"province": [
440000
],
"isp": [
"001"
],
"group_by": [
"domain",
"app",
"stream",
"province",
"isp"
]
}
正常响应示例
{
"code": 100000,
"message": "success",
"start_time": 1655704800,
"end_time": 1655712000,
"interval": "1m",
"req_bandwidth_data_interval": [
{
"time_stamp": 1655709000,
"domain": "ctyun.cn",
"app": "live875",
"stream": "testlive1655708999875",
"province": 440000,
"isp": "001",
"bandwidth": 3121
}
]
}
错误码请参考: 参数code和message含义