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

用量查询

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

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

我的收藏

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

说明

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

调用说明

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

前提条件

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

调用示例

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

查询直播域名带宽用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_bandwidth_data_body_domain_list = []

      describe_live_bandwidth_data_body_domain_list_item = []
      describe_live_bandwidth_data_body_domain_list_item.append("example.com")
      describe_live_bandwidth_data_body_domain_list.append(describe_live_bandwidth_data_body_domain_list_item)

      body["DomainList"] = describe_live_bandwidth_data_body_domain_list

      
      # 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
      # <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，不能同时查询其他协议。
      
      describe_live_bandwidth_data_body_protocol_list = []

      describe_live_bandwidth_data_body_protocol_list_item = []
      describe_live_bandwidth_data_body_protocol_list_item.append("HTTP-FLV")
      describe_live_bandwidth_data_body_protocol_list_item.append("RTMP")
      describe_live_bandwidth_data_body_protocol_list.append(describe_live_bandwidth_data_body_protocol_list_item)

      body["ProtocolList"] = describe_live_bandwidth_data_body_protocol_list

      
      # 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
      # <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) 接口获取运营商对应的标识符。
      
      describe_live_bandwidth_data_body_isp_list = []

      describe_live_bandwidth_data_body_isp_list_item = []
      describe_live_bandwidth_data_body_isp_list_item.append("telecom")
      describe_live_bandwidth_data_body_isp_list_item.append("unicom")
      describe_live_bandwidth_data_body_isp_list.append(describe_live_bandwidth_data_body_isp_list_item)

      body["ISPList"] = describe_live_bandwidth_data_body_isp_list

      
      # CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_bandwidth_data_body_region_list = []

      describe_live_bandwidth_data_body_region_list_item = {} 
 
      # 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。 
      describe_live_bandwidth_data_body_region_list_item["Area"] = "CN"
      
      # 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
      describe_live_bandwidth_data_body_region_list_item["Country"] = "CN"
      
      # 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
      describe_live_bandwidth_data_body_region_list_item["Province"] = "beijing"
      describe_live_bandwidth_data_body_region_list.append(describe_live_bandwidth_data_body_region_list_item)
      body["RegionList"] = describe_live_bandwidth_data_body_region_list

        
      
      # 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_bandwidth_data_body_user_region_list = []

      describe_live_bandwidth_data_body_user_region_list_item = {} 
 
      # 大区，映射关系请参见区域映射
      describe_live_bandwidth_data_body_user_region_list_item["Area"] = " "
      
      # 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
      describe_live_bandwidth_data_body_user_region_list_item["Country"] = " "
      
      # 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
      describe_live_bandwidth_data_body_user_region_list_item["Province"] = " "
      describe_live_bandwidth_data_body_user_region_list.append(describe_live_bandwidth_data_body_user_region_list_item)
      body["UserRegionList"] = describe_live_bandwidth_data_body_user_region_list

        
      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2021-04-13T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 300
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名； </li>
      # <li> ISP：运营商； </li>
      # <li> Protocol：推拉流协议。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_bandwidth_data_body_detail_field = []

      describe_live_bandwidth_data_body_detail_field_item = []
      describe_live_bandwidth_data_body_detail_field_item.append("Domain")
      describe_live_bandwidth_data_body_detail_field.append(describe_live_bandwidth_data_body_detail_field_item)

      body["DetailField"] = describe_live_bandwidth_data_body_detail_field

      resp = service.describe_live_bandwidth_data(body)
      print(resp)

查询直播域名流量用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_traffic_data_body_domain_list = []

      describe_live_traffic_data_body_domain_list_item = []
      describe_live_traffic_data_body_domain_list_item.append("example.com")
      describe_live_traffic_data_body_domain_list.append(describe_live_traffic_data_body_domain_list_item)

      body["DomainList"] = describe_live_traffic_data_body_domain_list

      
      # 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
      # <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，不能同时查询其他协议。
      
      describe_live_traffic_data_body_protocol_list = []

      describe_live_traffic_data_body_protocol_list_item = []
      describe_live_traffic_data_body_protocol_list_item.append("HTTP-FLV")
      describe_live_traffic_data_body_protocol_list_item.append("RTMP")
      describe_live_traffic_data_body_protocol_list.append(describe_live_traffic_data_body_protocol_list_item)

      body["ProtocolList"] = describe_live_traffic_data_body_protocol_list

      
      # 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
      # <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) 接口获取运营商对应的标识符。
      
      describe_live_traffic_data_body_isp_list = []

      describe_live_traffic_data_body_isp_list_item = []
      describe_live_traffic_data_body_isp_list_item.append("telecom")
      describe_live_traffic_data_body_isp_list.append(describe_live_traffic_data_body_isp_list_item)

      body["ISPList"] = describe_live_traffic_data_body_isp_list

      
      # CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_traffic_data_body_region_list = []

      describe_live_traffic_data_body_region_list_item = {} 
 
      # 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
      describe_live_traffic_data_body_region_list_item["Area"] = "CN"
      
      # 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
      describe_live_traffic_data_body_region_list_item["Country"] = "CN"
      
      # 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
      describe_live_traffic_data_body_region_list_item["Province"] = "beijing"
      describe_live_traffic_data_body_region_list.append(describe_live_traffic_data_body_region_list_item)
      body["RegionList"] = describe_live_traffic_data_body_region_list

        
      
      # 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_traffic_data_body_user_region_list = []

      describe_live_traffic_data_body_user_region_list_item = {} 
 
      # 大区，映射关系请参见[区域映射](https://www.volcengine.com/docs/6469/114196)
      describe_live_traffic_data_body_user_region_list_item["Area"] = " "
      
      # 国家，映射关系请参见[区域映射](https://www.volcengine.com/docs/6469/114196)
      describe_live_traffic_data_body_user_region_list_item["Country"] = " "
      
      # 国内为省，国外暂不支持该参数，映射关系请参见[区域映射](https://www.volcengine.com/docs/6469/114196)
      describe_live_traffic_data_body_user_region_list_item["Province"] = " "
      describe_live_traffic_data_body_user_region_list.append(describe_live_traffic_data_body_user_region_list_item)
      body["UserRegionList"] = describe_live_traffic_data_body_user_region_list

        
      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2021-04-13T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 300
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下。
      # <li> Domain：域名； </li>
      # <li> ISP：运营商； </li>
      # <li> Protocol：推拉流协议。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_traffic_data_body_detail_field = []

      describe_live_traffic_data_body_detail_field_item = []
      describe_live_traffic_data_body_detail_field_item.append("Domain")
      describe_live_traffic_data_body_detail_field.append(describe_live_traffic_data_body_detail_field_item)

      body["DetailField"] = describe_live_traffic_data_body_detail_field

      resp = service.describe_live_traffic_data(body)
      print(resp)

查询直播域名录制用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_record_data_body_domain_list = []

      describe_live_record_data_body_domain_list_item = []
      describe_live_record_data_body_domain_list_item.append("example.com")
      describe_live_record_data_body_domain_list.append(describe_live_record_data_body_domain_list_item)

      body["DomainList"] = describe_live_record_data_body_domain_list

      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2021-04-13T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 300
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数需传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_record_data_body_detail_field = []

      describe_live_record_data_body_detail_field_item = []
      describe_live_record_data_body_detail_field_item.append("Domain")
      describe_live_record_data_body_detail_field.append(describe_live_record_data_body_detail_field_item)

      body["DetailField"] = describe_live_record_data_body_detail_field

      
      # 查询流粒度数据时的应用名称。
      # note：
      # 使用 `App` 构造请求时，需同时定义 `Stream` 参数，不可缺省。
      body["App"] = "exampel_app"
      
      # 查询流粒度数据时的流名称，
      # note：
      # 使用 `Stream` 构造请求时，需同时定义 `App` 参数，不可缺省。
      body["Stream"] = "example_stream"

      resp = service.describe_live_record_data(body)
      print(resp)

查询直播域名转码用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_transcode_data_body_domain_list = []

      describe_live_transcode_data_body_domain_list_item = []
      describe_live_transcode_data_body_domain_list_item.append("example.com")
      describe_live_transcode_data_body_domain_list_item.append("example2.com")
      describe_live_transcode_data_body_domain_list.append(describe_live_transcode_data_body_domain_list_item)

      body["DomainList"] = describe_live_transcode_data_body_domain_list

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

      resp = service.describe_live_transcode_data(body)
      print(resp)

查询直播域名截图张数

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_snapshot_data_body_domain_list = []

      describe_live_snapshot_data_body_domain_list_item = []
      describe_live_snapshot_data_body_domain_list_item.append("example.com")
      describe_live_snapshot_data_body_domain_list_item.append("example2.com")
      describe_live_snapshot_data_body_domain_list.append(describe_live_snapshot_data_body_domain_list_item)

      body["DomainList"] = describe_live_snapshot_data_body_domain_list

      
      # 查询流粒度数据时的应用名称。
      # note：
      # 使用 `App` 构造请求时，需要同时定义 `Stream` 参数，不可缺省。
      body["App"] = "example_app"
      
      # 查询流粒度数据时的流名称。
      # note：
      # 使用 `Stream` 构造请求时，需要同时定义 `App` 参数，不可缺省。
      body["Stream"] = "example_stream"
      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2022-03-07T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 86400
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_snapshot_data_body_detail_field = []

      describe_live_snapshot_data_body_detail_field_item = []
      describe_live_snapshot_data_body_detail_field_item.append("Domain")
      describe_live_snapshot_data_body_detail_field.append(describe_live_snapshot_data_body_detail_field_item)

      body["DetailField"] = describe_live_snapshot_data_body_detail_field

      resp = service.describe_live_snapshot_data(body)
      print(resp)

查询截图审核用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_audit_data_body_domain_list = []

      describe_live_audit_data_body_domain_list_item = []
      describe_live_audit_data_body_domain_list_item.append("live.example1.net")
      describe_live_audit_data_body_domain_list_item.append("live.example2.net")
      describe_live_audit_data_body_domain_list.append(describe_live_audit_data_body_domain_list_item)

      body["DomainList"] = describe_live_audit_data_body_domain_list

      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2022-08-03T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "2022-08-04T00:00:00+08:00"
      
      # 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
      # <li> 86400：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
      body["Aggregation"] = 86400
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_audit_data_body_detail_field = []

      describe_live_audit_data_body_detail_field_item = []
      describe_live_audit_data_body_detail_field_item.append("Domain")
      describe_live_audit_data_body_detail_field.append(describe_live_audit_data_body_detail_field_item)

      body["DetailField"] = describe_live_audit_data_body_detail_field

      resp = service.describe_live_audit_data(body)
      print(resp)

查询拉流转推时长用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_pull_to_push_data_body_domain_list = []

      describe_live_pull_to_push_data_body_domain_list_item = []
      describe_live_pull_to_push_data_body_domain_list_item.append("example.com")
      describe_live_pull_to_push_data_body_domain_list.append(describe_live_pull_to_push_data_body_domain_list_item)

      body["DomainList"] = describe_live_pull_to_push_data_body_domain_list

      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2022-03-07T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 3600
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_pull_to_push_data_body_detail_field = []

      describe_live_pull_to_push_data_body_detail_field_item = []
      describe_live_pull_to_push_data_body_detail_field_item.append("Domain")
      describe_live_pull_to_push_data_body_detail_field.append(describe_live_pull_to_push_data_body_detail_field_item)

      body["DetailField"] = describe_live_pull_to_push_data_body_detail_field

      
      # 查询流粒度数据时的应用名称。
      # note：
      # 使用 `App` 构造请求时，需同时定义 `Stream` 参数，不可缺省。
      body["App"] = "test_app"
      
      # 查询流粒度数据时的流名称。
      # note：
      # 使用 `Stream` 构造请求时，需同时定义 `App` 参数，不可缺省。
      body["Stream"] = "test_stream"

      resp = service.describe_live_pull_to_push_data(body)
      print(resp)

查询直播时移存储用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
      # <li> 86400：（默认值）1 天。 </li>
      body["Aggregation"] = 86400
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "2022-02-17T23:59:59+08:00"
      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      # note：
      # 单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
      body["StartTime"] = "2022-02-11T00:00:00+08:00"
      
      # 域名空间列表，缺省情况表示查询当前用户的所有域名空间。
      
      describe_live_time_shift_data_body_vhosts = []

      describe_live_time_shift_data_body_vhosts_item = []
      describe_live_time_shift_data_body_vhosts_item.append("www.example.com")
      describe_live_time_shift_data_body_vhosts.append(describe_live_time_shift_data_body_vhosts_item)

      body["Vhosts"] = describe_live_time_shift_data_body_vhosts

      resp = service.describe_live_time_shift_data(body)
      print(resp)

查询 95 带宽峰值

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 域名列表，缺省情况下表示当前用户的所有推拉流域名。
      
      describe_live_p95_peak_bandwidth_data_body_domain_list = []

      describe_live_p95_peak_bandwidth_data_body_domain_list_item = []
      describe_live_p95_peak_bandwidth_data_body_domain_list_item.append("example.com")
      describe_live_p95_peak_bandwidth_data_body_domain_list.append(describe_live_p95_peak_bandwidth_data_body_domain_list_item)

      body["DomainList"] = describe_live_p95_peak_bandwidth_data_body_domain_list

      
      # 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
      # <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，不能同时查询其他协议。
      
      describe_live_p95_peak_bandwidth_data_body_protocol_list = []

      describe_live_p95_peak_bandwidth_data_body_protocol_list_item = []
      describe_live_p95_peak_bandwidth_data_body_protocol_list_item.append("HTTP-FLV")
      describe_live_p95_peak_bandwidth_data_body_protocol_list_item.append("HTTP-HLS")
      describe_live_p95_peak_bandwidth_data_body_protocol_list.append(describe_live_p95_peak_bandwidth_data_body_protocol_list_item)

      body["ProtocolList"] = describe_live_p95_peak_bandwidth_data_body_protocol_list

      
      # CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_p95_peak_bandwidth_data_body_region_list = []

      describe_live_p95_peak_bandwidth_data_body_region_list_item = {} 
 
      # 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
      describe_live_p95_peak_bandwidth_data_body_region_list_item["Area"] = "CN"
      
      # 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
      describe_live_p95_peak_bandwidth_data_body_region_list_item["Country"] = "CN"
      
      # 区域信息中的省份标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
      describe_live_p95_peak_bandwidth_data_body_region_list_item["Province"] = "beijing"
      describe_live_p95_peak_bandwidth_data_body_region_list.append(describe_live_p95_peak_bandwidth_data_body_region_list_item)
      body["RegionList"] = describe_live_p95_peak_bandwidth_data_body_region_list

        
      
      # 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
      # note：
      # 参数 `RegionList`和`UserRegionList` 不支持同时传入。
      
      describe_live_p95_peak_bandwidth_data_body_user_region_list = []

      describe_live_p95_peak_bandwidth_data_body_user_region_list_item = {} 
 
      # 大区，映射关系请参见区域映射
      describe_live_p95_peak_bandwidth_data_body_user_region_list_item["Area"] = "CN"
      
      # 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
      describe_live_p95_peak_bandwidth_data_body_user_region_list_item["Country"] = "CN"
      
      # 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
      describe_live_p95_peak_bandwidth_data_body_user_region_list_item["Province"] = "beijing"
      describe_live_p95_peak_bandwidth_data_body_user_region_list.append(describe_live_p95_peak_bandwidth_data_body_user_region_list_item)
      body["UserRegionList"] = describe_live_p95_peak_bandwidth_data_body_user_region_list

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

      resp = service.describe_live_p95_peak_bandwidth_data(body)
      print(resp)

查询拉流转推带宽用量

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 推流域名列表，缺省情况表示当前用户的所有推拉流域名。
      
      describe_live_pull_to_push_bandwidth_data_body_domain_list = []

      describe_live_pull_to_push_bandwidth_data_body_domain_list_item = []
      describe_live_pull_to_push_bandwidth_data_body_domain_list_item.append("example.com")
      describe_live_pull_to_push_bandwidth_data_body_domain_list.append(describe_live_pull_to_push_bandwidth_data_body_domain_list_item)

      body["DomainList"] = describe_live_pull_to_push_bandwidth_data_body_domain_list

      
      # 推流地址类型，可选值如下所示。
      # <li> Live：非第三方； </li>
      # <li> Third：（默认值）第三方。 </li>
      
      describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list = []

      describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list_item = []
      describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list_item.append("live")
      describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list_item.append("Third")
      describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list.append(describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list_item)

      body["DstAddrTypeList"] = describe_live_pull_to_push_bandwidth_data_body_dst_addr_type_list

      
      # 查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["StartTime"] = "2021-04-13T00:00:00+08:00"
      
      # 查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
      body["EndTime"] = "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["Aggregation"] = 300
      
      # 数据拆分的维度，缺省情况下不进行数据拆分，支持的维度如下所示。
      # <li> Domain：域名； </li>
      # <li> DstAddrType：推流地址类型。 </li>
      # note：
      # 配置数据拆分维度时，对应的维度参数传入多个值时会返回按维度进行拆分的数据；对应的维度只传入一个值时不返回按维度进行拆分的数据。
      
      describe_live_pull_to_push_bandwidth_data_body_detail_field = []

      describe_live_pull_to_push_bandwidth_data_body_detail_field_item = []
      describe_live_pull_to_push_bandwidth_data_body_detail_field_item.append("Domain")
      describe_live_pull_to_push_bandwidth_data_body_detail_field.append(describe_live_pull_to_push_bandwidth_data_body_detail_field_item)

      body["DetailField"] = describe_live_pull_to_push_bandwidth_data_body_detail_field

      resp = service.describe_live_pull_to_push_bandwidth_data(body)
      print(resp)