Appearance
直播流量消耗
接口描述
按直播间查询当前商家的累计流量消耗。对应控制台“流量统计 → 直播流量消耗”。
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/Traffic/roomTrafficConsumeList/2.0.0 - 频率限制:每接口
10秒100次,按客户端 IP 和 User-Agent 区分。 - 身份认证:参考接口签名介绍,仅查询调用凭证所属商家的数据,无需传入
uid。
请求参数
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| page | 是 | integer | 页码,从1开始 | 1 |
| page_size | 是 | integer | 每页直播间数量,范围1至100 | 10 |
| name | 否 | string | 直播间名称,最多100个字符,模糊查询;不传则不按名称筛选 | "示例直播间" |
| group_id | 否 | integer | 直播间分组ID;0 表示未分组,不传则不按分组筛选 | 1001 |
统计说明
- 本接口返回直播间累计数据,不支持开始日期、结束日期筛选。查询指定日期区间的每日汇总,请使用每日流量消耗。
- 按直播间分页,各流量字段单位为 GB,
1 GB = 1,000,000,000 字节,保留两位小数,不带单位后缀。 used_room_traffic为符合筛选条件的全部直播间的标准直播与超低延迟直播流量合计,不受当前分页影响,不包含视频流量。vod_traffic为对应直播间的视频流量。- 没有符合条件的直播间时,返回
count=0、used_room_traffic="0.00"和空数组lists=[]。
请求示例
json
{
"page": 1,
"page_size": 10,
"name": "示例直播间"
}响应参数
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| code | 是 | integer | 业务状态码,200 成功,400 失败 | 200 |
| msg | 是 | string | 提示信息 | "Success" |
| data | 是 | object | 查询结果;以下结构为成功时返回 | 见响应示例 |
data 参数结构
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| count | 是 | integer | 符合筛选条件的直播间总数 | 1 |
| used_room_traffic | 是 | string | 全部符合条件的直播间累计直播使用流量,单位 GB,无单位后缀,不含视频流量 | "12.50" |
| lists | 是 | array | 当前页直播间流量记录,字段名为 lists | 见响应示例 |
lists 参数结构
| 参数 | 必选 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| room_id | 是 | integer | 直播间ID | 100001 |
| push_app_nick | 是 | string | 直播间名称 | "示例直播间" |
| stream_name | 是 | string | 直播流标识 | "example_stream_001" |
| live_traffic | 是 | string | 累计标准直播流量,单位 GB | "10.00" |
| no_delay_traffic | 是 | string | 累计超低延迟直播流量,单位 GB | "2.50" |
| vod_traffic | 是 | string | 累计视频流量,单位 GB | "3.00" |
响应示例
以下数据均为示例数据。
json
{
"code": 200,
"msg": "Success",
"data": {
"count": 1,
"used_room_traffic": "12.50",
"lists": [
{
"room_id": 100001,
"push_app_nick": "示例直播间",
"stream_name": "example_stream_001",
"live_traffic": "10.00",
"no_delay_traffic": "2.50",
"vod_traffic": "3.00"
}
]
}
}状态码说明
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 参数不符合要求、请求过于频繁或服务暂不可用,请根据 msg 调整请求 |
| 601 | 数据查询异常,请稍后重试 |