Appearance
视频流量消耗
接口描述
查询当前商家指定日期区间内的视频流量消耗,包含回放视频和素材视频,支持按视频名称或素材ID筛选。对应控制台“流量统计 → 视频流量消耗”。
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/Traffic/getVideoTrafficConsumeList/2.0.0 - 频率限制:每接口
10秒100次,按客户端 IP 和 User-Agent 区分。 - 身份认证:参考接口签名介绍,仅查询调用凭证所属商家的数据,无需传入
uid。
请求参数
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| page | 是 | integer | 页码,从1开始 | 1 |
| page_size | 是 | integer | 每页视频记录数量,范围1至100 | 10 |
| start_time | 是 | string | 开始日期,格式 YYYY-MM-DD | "2026-10-01" |
| end_time | 是 | string | 结束日期,格式 YYYY-MM-DD,不得早于开始日期 | "2026-10-21" |
| file_name | 否 | string | 视频名称,最多100个字符,模糊查询;不传则不按名称筛选 | "示例视频" |
| file_id | 否 | integer | 素材ID,对应返回记录的 id,不是返回记录中的字符串 file_id;不传则不按素材ID筛选 | 10001 |
统计说明
- 单次查询日期范围最多366天。
- 日期按北京时间(UTC+8)解释,包含开始日期和结束日期的全天数据;支持查询自
2022-05-30起的流量数据。 - 按视频记录分页,
total_traffic为整个日期区间内符合筛选条件的视频流量合计,不受当前分页影响。 - 流量单位为 GB,
1 GB = 1,000,000,000 字节,保留两位小数。total_traffic带GB后缀,记录中的data_bytes不带单位后缀。 data_reqs表示播放请求次数,不是去重观看人数。id是素材ID;回放视频尚无对应素材时可能为0。字符串file_id是视频文件标识,两者不可混用。- 没有符合条件的视频记录时,返回
total=0、total_traffic="0.00GB"和空数组list=[]。
请求示例
json
{
"page": 1,
"page_size": 10,
"start_time": "2026-10-01",
"end_time": "2026-10-21",
"file_name": "示例视频"
}响应参数
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| code | 是 | integer | 业务状态码,200 成功,400 失败 | 200 |
| msg | 是 | string | 提示信息 | "Success" |
| data | 是 | object | 查询结果;以下结构为成功时返回 | 见响应示例 |
data 参数结构
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| total | 是 | integer | 符合筛选条件的视频记录总数 | 1 |
| total_traffic | 是 | string | 日期区间内符合筛选条件的视频使用流量,带 GB 后缀 | "1.25GB" |
| list | 是 | array | 当前页视频流量记录 | 见响应示例 |
list 参数结构
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| id | 是 | integer | 素材ID,无对应素材时为 0 | 10001 |
| upload_name | 是 | string | 视频名称 | "示例视频" |
| business_type | 是 | string | 视频类型:"1" 回放视频、"4" 素材视频 | "4" |
| snap_url | 是 | string | 视频封面地址,无封面时可为空字符串 | "https://example.com/video-cover.jpg" |
| size | 是 | string | 视频文件大小,带单位的格式化文本,不是流量消耗 | "50.00 MB" |
| video_dur | 是 | string | 视频时长文本 | "00:15:30" |
| data_reqs | 是 | integer | 日期区间内的播放请求次数 | 50 |
| data_bytes | 是 | string | 日期区间内的视频使用流量,单位 GB,无单位后缀 | "1.25" |
| file_id | 是 | string | 视频文件标识,不是素材ID | "example_video_file_001" |
响应示例
以下数据均为示例数据。
json
{
"code": 200,
"msg": "Success",
"data": {
"total": 1,
"total_traffic": "1.25GB",
"list": [
{
"id": 10001,
"upload_name": "示例视频",
"business_type": "4",
"snap_url": "https://example.com/video-cover.jpg",
"size": "50.00 MB",
"video_dur": "00:15:30",
"data_reqs": 50,
"data_bytes": "1.25",
"file_id": "example_video_file_001"
}
]
}
}状态码说明
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 参数不符合要求、请求过于频繁或服务暂不可用,请根据 msg 调整请求 |
| 601 | 数据查询异常,请稍后重试 |