You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

用量查询

最近更新时间：2024.04.15 11:37:00

首次发布时间：2023.12.28 21:21:52

我的收藏

阅读本文，您可以获取 Java SDK 用量查询的接口调用示例，实现快速开发。

说明

本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档或打开 API Explorer 的文档说明页签查看。

前提条件

调用接口前，请先完成 Java SDK 的安装及初始化操作

调用示例

本节为您介绍用量查询相关接口的功能和调用示例。

查询直播域名带宽用量

您可以调用 DescribeLiveBandwidthData 接口查询直播域名带宽用量。详细的参数说明可参见 DescribeLiveBandwidthData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveBandwidthDataBody; 
import com.volcengine.model.live.v20230101.DescribeLiveBandwidthDataBodyRegionListItem; 
import com.volcengine.model.live.v20230101.DescribeLiveBandwidthDataBodyUserRegionListItem;
import com.volcengine.model.live.v20230101.DescribeLiveBandwidthDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveBandwidthDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveBandwidthDataBody body = new DescribeLiveBandwidthDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveBandwidthDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLiveBandwidthDataBodyDomainList); 
    
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <li> HTTP-FLV：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 </li>
    // <li> HTTP-HLS：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 </li>
    // <li> RTMP：Real Time Message Protocol，实时信息传输协议。 </li>
    // <li> RTM：Real Time Media，超低延时直播协议。 </li>
    // <li> SRT：Secure Reliable Transport，安全可靠传输协议。 </li>
    // <li> QUIC：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。 </li>
    // note：
    // 如果查询推拉流协议为 QUIC，不能同时查询其他协议。
    List<String> DescribeLiveBandwidthDataBodyProtocolList = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyProtocolList.add("HTTP-FLV");
    DescribeLiveBandwidthDataBodyProtocolList.add("RTMP");
    
    body.setProtocolList(DescribeLiveBandwidthDataBodyProtocolList); 
    
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <li> unicom：联通； </li>
    // <li> railcom：铁通； </li>
    // <li> telecom：电信； </li>
    // <li> mobile：移动； </li>
    // <li> cernet：教育网； </li>
    // <li> tianwei：天威； </li>
    // <li> alibaba：阿里巴巴； </li>
    // <li> tencent：腾讯； </li>
    // <li> drpeng：鹏博士； </li>
    // <li> btvn：广电； </li>
    // <li> huashu：华数； </li>
    // <li> other：其他。 </li>
    // 您也可以通过 [DescribeLiveISPData](https//www.volcengine.com/docs/6469/1133974) 接口获取运营商对应的标识符。
    List<String> DescribeLiveBandwidthDataBodyISPList = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyISPList.add("telecom");
    DescribeLiveBandwidthDataBodyISPList.add("unicom");
    
    body.setISPList(DescribeLiveBandwidthDataBodyISPList); 
    
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveBandwidthDataBodyRegionListItem> DescribeLiveBandwidthDataBodyRegionList = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyRegionListItem DescribeLiveBandwidthDataBodyRegionListItem = new DescribeLiveBandwidthDataBodyRegionListItem(); 
 
    // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。 
    DescribeLiveBandwidthDataBodyRegionListItem.setArea("CN");
    
    // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
    DescribeLiveBandwidthDataBodyRegionListItem.setCountry("CN");
    
    // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
    DescribeLiveBandwidthDataBodyRegionListItem.setProvince("beijing");
    DescribeLiveBandwidthDataBodyRegionList.add(DescribeLiveBandwidthDataBodyRegionListItem);

    body.setRegionList(DescribeLiveBandwidthDataBodyRegionList); 

    
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveBandwidthDataBodyUserRegionListItem> DescribeLiveBandwidthDataBodyUserRegionList = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyUserRegionListItem DescribeLiveBandwidthDataBodyUserRegionListItem = new DescribeLiveBandwidthDataBodyUserRegionListItem(); 
 
    // 大区，映射关系请参见区域映射
    DescribeLiveBandwidthDataBodyUserRegionListItem.setArea(" ");
    
    // 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
    DescribeLiveBandwidthDataBodyUserRegionListItem.setCountry(" ");
    
    // 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
    DescribeLiveBandwidthDataBodyUserRegionListItem.setProvince(" ");
    DescribeLiveBandwidthDataBodyUserRegionList.add(DescribeLiveBandwidthDataBodyUserRegionListItem);

    body.setUserRegionList(DescribeLiveBandwidthDataBodyUserRegionList); 

    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 300：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询最大时间范围为 366 天； </li>
    // <li> 3600：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询最大时间范围为 366 天； </li>
    // <li> 86400：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询最大时间范围为 366 天。 </li>
    body.setAggregation(300);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名； </li>
    // <li> ISP：运营商； </li>
    // <li> Protocol：推拉流协议。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLiveBandwidthDataBodyDetailField = new ArrayList<>(); 

    DescribeLiveBandwidthDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLiveBandwidthDataBodyDetailField);

    try {
      DescribeLiveBandwidthDataRes resp = service.describeLiveBandwidthData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询直播域名流量用量

您可以调用 DescribeLiveTrafficData 接口查询直播域名流量用量。详细的参数说明可参见 DescribeLiveTrafficData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveTrafficDataBody; 
import com.volcengine.model.live.v20230101.DescribeLiveTrafficDataBodyRegionListItem; 
import com.volcengine.model.live.v20230101.DescribeLiveTrafficDataBodyUserRegionListItem;
import com.volcengine.model.live.v20230101.DescribeLiveTrafficDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveTrafficDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveTrafficDataBody body = new DescribeLiveTrafficDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveTrafficDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLiveTrafficDataBodyDomainList); 
    
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <li> HTTP-FLV：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 </li>
    // <li> HTTP-HLS：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 </li>
    // <li> RTMP：Real Time Message Protocol，实时信息传输协议。 </li>
    // <li> RTM：Real Time Media，超低延时直播协议。 </li>
    // <li> SRT：Secure Reliable Transport，安全可靠传输协议。 </li>
    // <li> QUIC：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。 </li>
    // note：
    // 如果查询推拉流协议为 QUIC，不能同时查询其他协议。
    List<String> DescribeLiveTrafficDataBodyProtocolList = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyProtocolList.add("HTTP-FLV");
    DescribeLiveTrafficDataBodyProtocolList.add("RTMP");
    
    body.setProtocolList(DescribeLiveTrafficDataBodyProtocolList); 
    
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <li> unicom：联通； </li>
    // <li> railcom：铁通； </li>
    // <li> telecom：电信； </li>
    // <li> mobile：移动； </li>
    // <li> cernet：教育网； </li>
    // <li> tianwei：天威； </li>
    // <li> alibaba：阿里巴巴； </li>
    // <li> tencent：腾讯； </li>
    // <li> drpeng：鹏博士； </li>
    // <li> btvn：广电； </li>
    // <li> huashu：华数； </li>
    // <li> other：其他。 </li>
    // 您也可以通过 [DescribeLiveISPData](https//www.volcengine.com/docs/6469/1133974) 接口获取运营商对应的标识符。
    List<String> DescribeLiveTrafficDataBodyISPList = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyISPList.add("telecom");
    
    body.setISPList(DescribeLiveTrafficDataBodyISPList); 
    
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveTrafficDataBodyRegionListItem> DescribeLiveTrafficDataBodyRegionList = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyRegionListItem DescribeLiveTrafficDataBodyRegionListItem = new DescribeLiveTrafficDataBodyRegionListItem(); 
 
    // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。
    DescribeLiveTrafficDataBodyRegionListItem.setArea("CN");
    
    // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
    DescribeLiveTrafficDataBodyRegionListItem.setCountry("CN");
    
    // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
    DescribeLiveTrafficDataBodyRegionListItem.setProvince("beijing");
    DescribeLiveTrafficDataBodyRegionList.add(DescribeLiveTrafficDataBodyRegionListItem);

    body.setRegionList(DescribeLiveTrafficDataBodyRegionList); 

    
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveTrafficDataBodyUserRegionListItem> DescribeLiveTrafficDataBodyUserRegionList = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyUserRegionListItem DescribeLiveTrafficDataBodyUserRegionListItem = new DescribeLiveTrafficDataBodyUserRegionListItem(); 
 
    // 大区，映射关系请参见[区域映射](https//www.volcengine.com/docs/6469/114196)
    DescribeLiveTrafficDataBodyUserRegionListItem.setArea(" ");
    
    // 国家，映射关系请参见[区域映射](https//www.volcengine.com/docs/6469/114196)
    DescribeLiveTrafficDataBodyUserRegionListItem.setCountry(" ");
    
    // 国内为省，国外暂不支持该参数，映射关系请参见[区域映射](https//www.volcengine.com/docs/6469/114196)
    DescribeLiveTrafficDataBodyUserRegionListItem.setProvince(" ");
    DescribeLiveTrafficDataBodyUserRegionList.add(DescribeLiveTrafficDataBodyUserRegionListItem);

    body.setUserRegionList(DescribeLiveTrafficDataBodyUserRegionList); 

    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 300：（默认值）5 分钟。聚合粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询最大时间范围为 366 天； </li>
    // <li> 3600：1 小时。聚合粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询最大时间范围为 366 天； </li>
    // <li> 86400：1 天。聚合粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询最大时间范围为 366 天。 </li>
    body.setAggregation(300);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下。
    // <li> Domain：域名； </li>
    // <li> ISP：运营商； </li>
    // <li> Protocol：推拉流协议。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLiveTrafficDataBodyDetailField = new ArrayList<>(); 

    DescribeLiveTrafficDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLiveTrafficDataBodyDetailField);

    try {
      DescribeLiveTrafficDataRes resp = service.describeLiveTrafficData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询直播域名录制用量

您可以调用 DescribeLiveRecordData 接口查询直播域名录制用量。详细的参数说明可参见 DescribeLiveRecordData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveRecordDataBody;
import com.volcengine.model.live.v20230101.DescribeLiveRecordDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveRecordDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveRecordDataBody body = new DescribeLiveRecordDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveRecordDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveRecordDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLiveRecordDataBodyDomainList); 
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。  
    // <li> 300：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询最大时间范围为 366 天；  </li>
    // <li> 3600：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天；  </li>
    // <li> 86400：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    body.setAggregation(300);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数需传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLiveRecordDataBodyDetailField = new ArrayList<>(); 

    DescribeLiveRecordDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLiveRecordDataBodyDetailField); 
    
    // 查询流粒度数据时的应用名称。
    // note：
    // 使用 `App` 构造请求时，需同时定义 `Stream` 参数，不可缺省。
    body.setApp("exampel_app");
    
    // 查询流粒度数据时的流名称，
    // note：
    // 使用 `Stream` 构造请求时，需同时定义 `App` 参数，不可缺省。
    body.setStream("example_stream");

    try {
      DescribeLiveRecordDataRes resp = service.describeLiveRecordData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询直播域名转码用量

您可以调用 DescribeLiveTranscodeData 接口查询直播域名转码用量。详细的参数说明可参见 DescribeLiveTranscodeData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveTranscodeDataBody;
import com.volcengine.model.live.v20230101.DescribeLiveTranscodeDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveTranscodeDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveTranscodeDataBody body = new DescribeLiveTranscodeDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveTranscodeDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveTranscodeDataBodyDomainList.add("example.com");
    DescribeLiveTranscodeDataBodyDomainList.add("example2.com");
    
    body.setDomainList(DescribeLiveTranscodeDataBodyDomainList); 
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    // note：
    // 单次查询最大时间跨度为 93 天，历史查询最大时间范围为 366 天。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 86400：（默认值）1 天。 </li>
    body.setAggregation(86400);
    
    // 查询流粒度数据时的应用名称。
    // note：
    // 使用 `App` 构造请求时，需要同时定义 `Stream` 参数，不可缺省。
    body.setApp("test_app");
    
    // 查询流粒度数据时的流名称。
    // note：
    // 使用 `Stream` 构造请求时，需要同时定义 `App` 参数，不可缺省。
    body.setStream("test_stream");

    try {
      DescribeLiveTranscodeDataRes resp = service.describeLiveTranscodeData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询直播域名截图张数

您可以调用 DescribeLiveSnapshotData 接口查询直播域名截图张数。详细的参数说明可参见 DescribeLiveSnapshotData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveSnapshotDataBody;
import com.volcengine.model.live.v20230101.DescribeLiveSnapshotDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveSnapshotDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveSnapshotDataBody body = new DescribeLiveSnapshotDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveSnapshotDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveSnapshotDataBodyDomainList.add("example.com");
    DescribeLiveSnapshotDataBodyDomainList.add("example2.com");
    
    body.setDomainList(DescribeLiveSnapshotDataBodyDomainList); 
    
    // 查询流粒度数据时的应用名称。
    // note：
    // 使用 `App` 构造请求时，需要同时定义 `Stream` 参数，不可缺省。
    body.setApp("example_app");
    
    // 查询流粒度数据时的流名称。
    // note：
    // 使用 `Stream` 构造请求时，需要同时定义 `App` 参数，不可缺省。
    body.setStream("example_stream");
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2022-03-07T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2022-03-08T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。  
    // <li> 300：5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天；  </li>
    // <li> 3600：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天；  </li>
    // <li> 86400：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    body.setAggregation(86400);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLiveSnapshotDataBodyDetailField = new ArrayList<>(); 

    DescribeLiveSnapshotDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLiveSnapshotDataBodyDetailField);

    try {
      DescribeLiveSnapshotDataRes resp = service.describeLiveSnapshotData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询截图审核用量

您可以调用 DescribeLiveAuditData 接口查询截图审核用量。详细的参数说明可参见 DescribeLiveAuditData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveAuditDataBody;
import com.volcengine.model.live.v20230101.DescribeLiveAuditDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveAuditDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveAuditDataBody body = new DescribeLiveAuditDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLiveAuditDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveAuditDataBodyDomainList.add("live.example1.net");
    DescribeLiveAuditDataBodyDomainList.add("live.example2.net");
    
    body.setDomainList(DescribeLiveAuditDataBodyDomainList); 
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2022-08-03T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2022-08-04T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 86400：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    body.setAggregation(86400);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLiveAuditDataBodyDetailField = new ArrayList<>(); 

    DescribeLiveAuditDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLiveAuditDataBodyDetailField);

    try {
      DescribeLiveAuditDataRes resp = service.describeLiveAuditData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询拉流转推时长用量

您可以调用 DescribeLivePullToPushData 接口查询拉流转推时长用量。详细的参数说明可参见 DescribeLivePullToPushData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLivePullToPushDataBody;
import com.volcengine.model.live.v20230101.DescribeLivePullToPushDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLivePullToPushDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLivePullToPushDataBody body = new DescribeLivePullToPushDataBody();
     
    // 域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLivePullToPushDataBodyDomainList = new ArrayList<>(); 

    DescribeLivePullToPushDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLivePullToPushDataBodyDomainList); 
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2022-03-07T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2022-03-08T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 60：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 1 天，历史查询时间范围为 366 天； </li>
    // <li> 3600：1 小时。时间粒度为 1 小时时，单次查询时间跨度为 93 天，历史查询时间范围为 366 天； </li>
    // <li> 86400：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    body.setAggregation(3600);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLivePullToPushDataBodyDetailField = new ArrayList<>(); 

    DescribeLivePullToPushDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLivePullToPushDataBodyDetailField); 
    
    // 查询流粒度数据时的应用名称。
    // note：
    // 使用 `App` 构造请求时，需同时定义 `Stream` 参数，不可缺省。
    body.setApp("test_app");
    
    // 查询流粒度数据时的流名称。
    // note：
    // 使用 `Stream` 构造请求时，需同时定义 `App` 参数，不可缺省。
    body.setStream("test_stream");

    try {
      DescribeLivePullToPushDataRes resp = service.describeLivePullToPushData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询直播时移存储用量

您可以调用 DescribeLiveTimeShiftData 接口查询直播时移存储用量。详细的参数说明可参见 DescribeLiveTimeShiftData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveTimeShiftDataBody;
import com.volcengine.model.live.v20230101.DescribeLiveTimeShiftDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveTimeShiftDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveTimeShiftDataBody body = new DescribeLiveTimeShiftDataBody();
     
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 86400：（默认值）1 天。 </li>
    body.setAggregation(86400);
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2022-02-17T23:59:59+08:00");
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    // note：
    // 单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
    body.setStartTime("2022-02-11T00:00:00+08:00");
    
    // 域名空间列表，缺省情况表示查询当前用户的所有域名空间。
    List<String> DescribeLiveTimeShiftDataBodyVhosts = new ArrayList<>(); 

    DescribeLiveTimeShiftDataBodyVhosts.add("www.example.com");
    
    body.setVhosts(DescribeLiveTimeShiftDataBodyVhosts);

    try {
      DescribeLiveTimeShiftDataRes resp = service.describeLiveTimeShiftData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询 95 带宽峰值

您可以调用 DescribeLiveP95PeakBandwidthData 接口查询 95 带宽峰值。详细的参数说明可参见 DescribeLiveP95PeakBandwidthData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLiveP95PeakBandwidthDataBody; 
import com.volcengine.model.live.v20230101.DescribeLiveP95PeakBandwidthDataBodyRegionListItem; 
import com.volcengine.model.live.v20230101.DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem;
import com.volcengine.model.live.v20230101.DescribeLiveP95PeakBandwidthDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLiveP95PeakBandwidthDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLiveP95PeakBandwidthDataBody body = new DescribeLiveP95PeakBandwidthDataBody();
     
    // 域名列表，缺省情况下表示当前用户的所有推拉流域名。
    List<String> DescribeLiveP95PeakBandwidthDataBodyDomainList = new ArrayList<>(); 

    DescribeLiveP95PeakBandwidthDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLiveP95PeakBandwidthDataBodyDomainList); 
    
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <li> HTTP-FLV：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 </li>
    // <li> HTTP-HLS：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 </li>
    // <li> RTMP：Real Time Message Protocol，实时信息传输协议。 </li>
    // <li> RTM：Real Time Media，超低延时直播协议。 </li>
    // <li> SRT：Secure Reliable Transport，安全可靠传输协议。 </li>
    // <li> QUIC：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。 </li>
    // note：
    // 如果查询推拉流协议为 QUIC，不能同时查询其他协议。
    List<String> DescribeLiveP95PeakBandwidthDataBodyProtocolList = new ArrayList<>(); 

    DescribeLiveP95PeakBandwidthDataBodyProtocolList.add("HTTP-FLV");
    DescribeLiveP95PeakBandwidthDataBodyProtocolList.add("HTTP-HLS");
    
    body.setProtocolList(DescribeLiveP95PeakBandwidthDataBodyProtocolList); 
    
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveP95PeakBandwidthDataBodyRegionListItem> DescribeLiveP95PeakBandwidthDataBodyRegionList = new ArrayList<>(); 

    DescribeLiveP95PeakBandwidthDataBodyRegionListItem DescribeLiveP95PeakBandwidthDataBodyRegionListItem = new DescribeLiveP95PeakBandwidthDataBodyRegionListItem(); 
 
    // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。
    DescribeLiveP95PeakBandwidthDataBodyRegionListItem.setArea("CN");
    
    // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
    DescribeLiveP95PeakBandwidthDataBodyRegionListItem.setCountry("CN");
    
    // 区域信息中的省份标识符，如何获取请参见[查询区域标识符](https//www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
    DescribeLiveP95PeakBandwidthDataBodyRegionListItem.setProvince("beijing");
    DescribeLiveP95PeakBandwidthDataBodyRegionList.add(DescribeLiveP95PeakBandwidthDataBodyRegionListItem);

    body.setRegionList(DescribeLiveP95PeakBandwidthDataBodyRegionList); 

    
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    List<DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem> DescribeLiveP95PeakBandwidthDataBodyUserRegionList = new ArrayList<>(); 

    DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem = new DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem(); 
 
    // 大区，映射关系请参见区域映射
    DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem.setArea("CN");
    
    // 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
    DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem.setCountry("CN");
    
    // 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
    DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem.setProvince("beijing");
    DescribeLiveP95PeakBandwidthDataBodyUserRegionList.add(DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem);

    body.setUserRegionList(DescribeLiveP95PeakBandwidthDataBodyUserRegionList); 

    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    // note：
    // 单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 300：（默认值）5 分钟。 </li>
    body.setAggregation(300);

    try {
      DescribeLiveP95PeakBandwidthDataRes resp = service.describeLiveP95PeakBandwidthData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询拉流转推带宽用量

您可以调用 DescribeLivePullToPushBandwidthData 接口查询拉流转推带宽用量。详细的参数说明可参见 DescribeLivePullToPushBandwidthData 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeLivePullToPushBandwidthDataBody;
import com.volcengine.model.live.v20230101.DescribeLivePullToPushBandwidthDataRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class DescribeLivePullToPushBandwidthDataDemo  {
  public static void main(String[] args) {
    // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
    LiveService service = LiveService.getInstance();

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeLivePullToPushBandwidthDataBody body = new DescribeLivePullToPushBandwidthDataBody();
     
    // 推流域名列表，缺省情况表示当前用户的所有推拉流域名。
    List<String> DescribeLivePullToPushBandwidthDataBodyDomainList = new ArrayList<>(); 

    DescribeLivePullToPushBandwidthDataBodyDomainList.add("example.com");
    
    body.setDomainList(DescribeLivePullToPushBandwidthDataBodyDomainList); 
    
    // 推流地址类型，可选值如下所示。
    // <li> Live：非第三方； </li>
    // <li> Third：（默认值）第三方。 </li>
    List<String> DescribeLivePullToPushBandwidthDataBodyDstAddrTypeList = new ArrayList<>(); 

    DescribeLivePullToPushBandwidthDataBodyDstAddrTypeList.add("live");
    DescribeLivePullToPushBandwidthDataBodyDstAddrTypeList.add("Third");
    
    body.setDstAddrTypeList(DescribeLivePullToPushBandwidthDataBodyDstAddrTypeList); 
    
    // 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setStartTime("2021-04-13T00:00:00+08:00");
    
    // 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
    body.setEndTime("2021-04-14T00:00:00+08:00");
    
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> 300：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> 3600：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； </li>
    // <li> 86400：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    body.setAggregation(300);
    
    // 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
    // <li> Domain：域名； </li>
    // <li> DstAddrType：推流地址类型。 </li>
    // note：
    // 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
    List<String> DescribeLivePullToPushBandwidthDataBodyDetailField = new ArrayList<>(); 

    DescribeLivePullToPushBandwidthDataBodyDetailField.add("Domain");
    
    body.setDetailField(DescribeLivePullToPushBandwidthDataBodyDetailField);

    try {
      DescribeLivePullToPushBandwidthDataRes resp = service.describeLivePullToPushBandwidthData(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}