com.volcengine.model.live.v20230101.DescribeLiveSourceTrafficDataBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.live.v20230101;
import com.alibaba.fastjson.JSON;
import java.util.List;
/**
* DescribeLiveSourceTrafficDataBody
*/
@lombok.Data
public final class DescribeLiveSourceTrafficDataBody {
/**
* 拉流域名列表,默认为空,表示查询所有域名的回源流量监控数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,获取待查询的拉流域名。
*
*
*
* :::tip
*
* `DomainList` 和 `Domain` 传且仅传一个。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "DomainList")
private List domainList;
/**
* 拉流域名,您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,获取待查询的拉流域名。
*
* :::tip
*
* 查询流粒度的回源流量监控数据时,需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Domain")
private String domain;
/**
* 回源流的应用名称,查询流粒度数据时必传,且需同时传入 `Domain` 和 `Stream`。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(\_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
*
* :::tip
*
* 查询流粒度的回源流量监控数据时,需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "App")
private String app;
/**
* 回源流的流名称,查询流粒度数据时必传,且需同时传入 `Domain` 和 `App`。支持由大小写字母(A - Z、a - z)、下划线(\_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
*
* :::tip
*
* 查询流粒度的回源流量监控数据时,需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Stream")
private String stream;
/**
* 提供网络接入服务的运营商标识符,缺省情况下表示所有运营商,支持的运营商如下所示。
*
*
*
* - `unicom`:联通;
*
* - `railcom`:铁通;
*
* - `telecom`:电信;
*
* - `mobile`:移动;
*
* - `cernet`:教育网;
*
* - `tianwei`:天威;
*
* - `alibaba`:阿里巴巴;
*
* - `tencent`:腾讯;
*
* - `drpeng`:鹏博士;
*
* - `btvn`:广电;
*
* - `huashu`:华数;
*
* - `other`:其他。
*
*
*
* 您也可以通过 [DescribeLiveISPData](https://www.volcengine.com/docs/6469/1133974) 接口获取运营商对应的标识符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ISPList")
private List iSPList;
/**
* 客户端 IP 所属区域的列表,缺省情况下表示所有区域。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "UserRegionList")
private List userRegionList;
/**
* 查询的开始时间,RFC3339 格式的时间戳,精度为秒。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "StartTime")
private String startTime;
/**
* 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EndTime")
private String endTime;
/**
* 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
*
*
*
* - `60`:1 分钟。时间粒度为 1 分钟时,单次查询最大时间跨度为 24 小时,历史查询时间范围为 366 天;
*
* - `300`:(默认值)5 分钟。时间粒度为 5 分钟时,单次查询最大时间跨度为 31 天,历史查询时间范围为 366 天;
*
* - `3600`:1 小时。时间粒度为 1 小时时,单次查询最大时间跨度为 93 天,历史查询时间范围为 366 天。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Aggregation")
private Integer aggregation;
/**
* 数据拆分的维度,默认为空表示按维度进行数据拆分,支持的维度如下所示。
*
* - `Domain`:域名;
*
* - `ISP`:运营商。
*
*
*
* :::tip
*
* 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "DetailField")
private List detailField;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}