统计分析--视频直播-火山引擎

文档中心

立即注册

导航

统计分析

最近更新时间：2024.05.21 15:00:58首次发布时间：2023.12.28 21:21:51

阅读本文，您可以获取 PHP SDK 统计分析的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍统计分析相关接口的功能和调用示例。

查询区域标识符

您可以调用 DescribeLiveRegionData 接口查询区域标识符。详细的参数说明可参见 DescribeLiveRegionData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  

  $response = $client->describeLiveRegionData();
  print_r($response);

查询运营商标识符

您可以调用 DescribeLiveISPData 接口查询运营商标识符。详细的参数说明可参见 DescribeLiveISPData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  

  $response = $client->describeLiveISPData();
  print_r($response);

查询单路推流监控数据

您可以调用 DescribeLivePushStreamMetrics 接口查询单路推流监控数据。详细的参数说明可参见 DescribeLivePushStreamMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 推流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的推流域名。
    "Domain" => "push.example.com",
    // 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    "App" => "live",
    // 流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:00:00+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `5`：5 秒； </li>
    // <li> `30`：（默认值）30 秒。 </li>
    "Aggregation" => 5,
  ];

  $response = $client->describeLivePushStreamMetrics($body);
  print_r($response);

查询多路推流监控数据

您可以调用 DescribeLiveBatchPushStreamMetrics 接口查询多路推流监控数据。详细的参数说明可参见 DescribeLiveBatchPushStreamMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 推流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的推流域名。
    "Domain" => "push.example.com",
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "App" => "live",
    // 流名称，预置与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `5`：5 秒； </li>
    // <li> `30`：30 秒； </li>
    // <li> `60`：（默认值）1 分钟。 </li>
    "Aggregation" => 5,
  ];

  $response = $client->describeLiveBatchPushStreamMetrics($body);
  print_r($response);

查询多路推流监控数据平均值

您可以调用 DescribeLiveBatchPushStreamAvgMetrics 接口查询多路推流监控数据平均值。详细的参数说明可参见 DescribeLiveBatchPushStreamAvgMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 推流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的推流域名。
    "Domain" => "push.example.com",
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "App" => "live",
    // 流名称，预置与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `5`：5 秒； </li>
    // <li> `30`：30 秒； </li>
    // <li> `60`：（默认值）1 分钟。 </li>
    "Aggregation" => 5,
  ];

  $response = $client->describeLiveBatchPushStreamAvgMetrics($body);
  print_r($response);

查询单路回源流监控数据

您可以调用 DescribeLiveSourceStreamMetrics 接口查询单路回源流监控数据。详细的参数说明可参见 DescribeLiveSourceStreamMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看回源流使用的拉流域名。
    "Domain" => "pull.example.com",
    // 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    "App" => "live",
    // 流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，当前接口默认且仅支持按 `30` 秒进行数据聚合。
    "Aggregation" => 30,
  ];

  $response = $client->describeLiveSourceStreamMetrics($body);
  print_r($response);

查询多路回源流监控数据

您可以调用 DescribeLiveBatchSourceStreamMetrics 接口查询多路回源流监控数据。详细的参数说明可参见 DescribeLiveBatchSourceStreamMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看回源流使用的拉流域名。
    "Domain" => "pull.example.com",
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定回源流。
    "App" => "live",
    // 流名称，预置与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定回源流。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `30`：30 秒； </li>
    // <li> `60`：（默认值）1 分钟。 </li>
    "Aggregation" => 30,
  ];

  $response = $client->describeLiveBatchSourceStreamMetrics($body);
  print_r($response);

查询多路回源流监控数据平均值

您可以调用 DescribeLiveBatchSourceStreamAvgMetrics 接口查询多路回源流监控数据平均值。详细的参数说明可参见 DescribeLiveBatchSourceStreamAvgMetrics 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看回源流使用的拉流域名。
    "Domain" => "pull.example.com",
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定回源流。
    "App" => "live",
    // 流名称，预置与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的监控数据时，需同时指定 `App` 和 `Stream` 来指定回源流。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 单次查询最大时间跨度为 1 天，历史查询最大时间范围为 366 天。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `30`：30 秒； </li>
    // <li> `60`：（默认值）1 分钟。 </li>
    "Aggregation" => 30,
  ];

  $response = $client->describeLiveBatchSourceStreamAvgMetrics($body);
  print_r($response);

查询直播流请求数和在线人数

您可以调用 DescribeLiveStreamSessionData 接口查询直播流请求数和在线人数。详细的参数说明可参见 DescribeLiveStreamSessionData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名列表，默认为空，表示查询所有域名的请求数和在线人数。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // `DomainList` 和 `Domain` 传且仅传一个。
    "DomainList" => ["pull.example.com"], 
    // 拉流域名，查询流粒度数据时必传，且需同时传入 `App` 和 `Stream`。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // 查询流粒度的请求数和在线人数数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定直播流。
    "Domain" => "pull.example.com",
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Domain` 和 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的回源流量监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "App" => "example_app",
    // 流名称，取值与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Domain` 和 `App`。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的回源流量监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "Stream" => "example_stream",
    // 指定拉流请求的 Referer 信息，默认为空，表示不对拉流请求的 Referer 字段进行校验。
    "RefererList" => ["www.test.com"], 
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <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`，不能同时查询其他协议。
    "ProtocolList" => ["HTTP-FLV","RTMP"], 
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    "RegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 003,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `ISP`：运营商； </li>
    // <li> `Protocol`：推拉流协议； </li>
    // <li> `Referer`：请求的 Referer 信息。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
  ];

  $response = $client->describeLiveStreamSessionData($body);
  print_r($response);

查询直播流或域名的流量监控数据

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

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 域名列表，默认为空，表示查询您视频直播产品下所有域名的流量监控数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的域名。
    "DomainList" => ["push.example.com"], 
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的流量监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "App" => "live",
    // 流名称，取值与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的流量监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "Stream" => "example_stream",
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <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`，不能同时查询其他协议。
    "ProtocolList" => ["HTTP-FLV","RTMP"], 
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "RegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "UserRegionList" => [ 
      [
        // 大区，映射关系请参见区域映射
        "Area" => "CN",
        // 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
        "Country" => "CN",
        // 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 300,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `Protocol`：推拉流协议； </li>
    // <li> `ISP`：运营商。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
  ];

  $response = $client->describeLiveMetricTrafficData($body);
  print_r($response);

查询直播流或域名的带宽监控数据

您可以调用 DescribeLiveMetricBandwidthData 接口查询直播流或域名的带宽监控数据。详细的参数说明可参见 DescribeLiveMetricBandwidthData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 域名列表，默认为空，表示查询您视频直播产品下所有域名的带宽监控数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的域名。
    "DomainList" => ["push.example.com"], 
    // 应用名称，取值与直播流地址中的 AppName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的带宽监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "App" => "live",
    // 流名称，预置与直播流地址中的 StreamName 字段取值相同，查询流粒度数据时必传，且需同时传入 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的带宽监控数据时，需同时指定 `App` 和 `Stream` 来指定直播流。
    "Stream" => "example_stream",
    // 推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。
    // <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`，不能同时查询其他协议。
    "ProtocolList" => ["HTTP-FLV","RTMP"], 
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "RegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "UserRegionList" => [ 
      [
        // 大区，映射关系请参见区域映射
        "Area" => "CN",
        // 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
        "Country" => "CN",
        // 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 300,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `Protocol`：推拉流协议； </li>
    // <li> `ISP`：运营商。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
  ];

  $response = $client->describeLiveMetricBandwidthData($body);
  print_r($response);

查询直播流或域名的回源流量监控数据

您可以调用 DescribeLiveSourceTrafficData 接口查询直播流或域名的回源流量监控数据。详细的参数说明可参见 DescribeLiveSourceTrafficData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名列表，默认为空，表示查询所有域名的回源流量监控数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // `DomainList` 和 `Domain` 传且仅传一个。
    "DomainList" => ["pull.example.com","pull2.example.com"], 
    // 拉流域名，查询流粒度数据时必传，且需同时传入 `App` 和 `Stream`。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // 查询流粒度的回源流量监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "Domain" => "pull.example.com",
    // 回源流的应用名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的回源流量监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "App" => "live",
    // 回源流的流名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `App`。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的回源流量监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "Stream" => "example_stream",
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    "UserRegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 300,
    // 数据拆分的维度，默认为空表示按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `ISP`：运营商。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
  ];

  $response = $client->describeLiveSourceTrafficData($body);
  print_r($response);

查询直播流或域名的回源带宽监控数据

您可以调用 DescribeLiveSourceBandwidthData 接口查询直播流或域名的回源带宽监控数据。详细的参数说明可参见 DescribeLiveSourceBandwidthData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 拉流域名列表，默认为空，表示查询所有域名的回源带宽监控数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // `DomainList` 和 `Domain` 传且仅传一个。
    "DomainList" => ["pull.example.com","pull2.example.com"], 
    // 拉流域名，查询流粒度数据时必传，且需同时传入 `App` 和 `Stream`。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的拉流域名。
    // note：
    // 查询流粒度的回源带宽监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "Domain" => "pull.example.com",
    // 回源流的应用名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度的回源带宽监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "App" => "example_app",
    // 回源流的流名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `App`。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度的回源带宽监控数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
    "Stream" => "example_stream",
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    "UserRegionList" => [ 
      [
        // 区域信息的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 300,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `ISP`：运营商。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["20"], 
  ];

  $response = $client->describeLiveSourceBandwidthData($body);
  print_r($response);

查询域名状态码占比

您可以调用 DescribeLivePlayStatusCodeData 接口查询域名状态码占比。详细的参数说明可参见 DescribeLivePlayStatusCodeData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 域名列表，默认为空时表示查询所有域名下产生的请求状态码占比数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询请求状态码占比数据的域名。
    "DomainList" => ["push.example.com","pull.example.com"], 
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "RegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
      ] 
    ], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    // note：
    // 参数 `RegionList`和`UserRegionList` 不支持同时传入。
    "UserRegionList" => [ 
      [
        // 大区，映射关系请参见区域映射
        "Area" => "CN",
        // 国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
        "Country" => "CN",
        // 国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。
        "Province" => "beijing",
      ] 
    ], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2024-04-28T14:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2024-04-28T14:00:00+08:00",
    // 聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：（默认值）1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 300,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
    // <li> `Domain`：域名； </li>
    // <li> `ISP`：运营商。 </li>
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
    // 请求类型，取值及含义如下所示。
    // <li> `Access`：（默认值）推流请求和拉流请求； </li>
    // <li> `Source`：回源请求。 </li>
    "Type" => "Access",
  ];

  $response = $client->describeLivePlayStatusCodeData($body);
  print_r($response);

查询 IP 地址归属的 CDN 节点

您可以调用 DescribeIpInfo 接口查询 IP 地址归属的 CDN 节点。详细的参数说明可参见 DescribeIpInfo 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 待查询的 IP 地址列表。支持 IPv4 和 IPv6 地址，一次最多查询 50 个 IP 地址。
    "Ips" => ["186.199.***.1"], 
  ];

  $response = $client->describeIpInfo($body);
  print_r($response);

查询峰值流数

您可以调用 DescribeLiveStreamCountData 接口查询峰值流数。详细的参数说明可参见 DescribeLiveStreamCountData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 直播流使用的域名列表，默认为空，表示查询所有全部域名下的峰值流数。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的域名。
    "DomainList" => ["push.exmaple.com","push2.example.com"], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； </li>
    // <li> `86400`：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 60,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，当前支持填写 `Domain` 表示按查询的域名为维度进行数据拆分。
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
    // 流类型，缺省情况下表示全部类型，支持的流类型取值如下。
    // <li> `push`：推流； </li>
    // <li> `relay-source`：回源流； </li>
    // <li> `transcode`：转码流。 </li>
    "StreamType" => ["push"], 
  ];

  $response = $client->describeLiveStreamCountData($body);
  print_r($response);

查询推流峰值流数

您可以调用 DescribeLivePushStreamCountData 接口查询推流峰值流数。详细的参数说明可参见 DescribeLivePushStreamCountData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 推流域名列表，默认为空，表示查询所有全部域名下的推流峰值流数。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的推流域名。
    "DomainList" => ["push.example.com","push2.example.com"], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    "StartTime" => "2021-08-16T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-08-16T00:01:59+08:00",
    // 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
    // <li> `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； </li>
    // <li> `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； </li>
    // <li> `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； </li>
    // <li> `86400`：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。 </li>
    "Aggregation" => 60,
    // 数据拆分的维度，默认为空表示不按维度进行数据拆分，当前仅支持填写 `Domain` 表示按查询的域名为维度进行数据拆分。
    // note：
    // 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
    "DetailField" => ["Domain"], 
    // 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
    // <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) 接口获取运营商对应的标识符。
    "ISPList" => ["telecom"], 
    // 客户端 IP 所属区域的列表，缺省情况下表示所有区域。
    "UserRegionList" => [ 
      [
        // 区域信息中的大区标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。
        "Area" => "CN",
        // 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。
        "Province" => "beijing",
        // 区域信息中的国家标识符，如何获取请参见[查询区域标识符](https://www.volcengine.com/docs/6469/1133973)。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
        "Country" => "CN",
      ] 
    ], 
  ];

  $response = $client->describeLivePushStreamCountData($body);
  print_r($response);

查询推流流信息

您可以调用 DescribeLivePushStreamInfoData 接口查询推流流信息。详细的参数说明可参见 DescribeLivePushStreamInfoData 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 直播推流使用的域名列表，缺省为空，表示当前账号下所有域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播推流使用的域名。
    "DomainList" => ["push.example.com"], 
    // 应用名称，取值与直播流地址中 AppName 字段取值相同，默认为空，表示查询所有应用名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    "App" => "example_app",
    // 流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示查询所有流名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    "Stream" => "example_stream",
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 支持查询最近 93 天以内的推流数据。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 支持查询最近 93 天以内的推流数据。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 查询数据的页码，默认为 `1`，表示查询第一页的数据，取值范围为正整数。
    "PageNum" => 1,
    // 每页显示的数据条数，默认为 `20`，取值范围为 [1,1000]。
    "PageSize" => 20,
  ];

  $response = $client->describeLivePushStreamInfoData($body);
  print_r($response);

查询直播域名转码数据明细

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

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [
    // 域名列表，默认为空，表示查询您视频直播产品下所有域名的转码用量数据。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，获取待查询的域名。
    "DomainList" => ["push.example.com","push2.example.com"], 
    // 查询的开始时间，RFC3339 格式的时间戳，精度为秒。
    // note：
    // 历史查询最大时间范围为 366 天。
    "StartTime" => "2021-04-13T00:00:00+08:00",
    // 查询的结束时间，RFC3339 格式的时间戳，精度为秒。
    "EndTime" => "2021-04-14T00:00:00+08:00",
    // 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    // note：
    // 查询流粒度数据时，需同时传入 `App` 和 `Stream`。
    "App" => "live",
    // 流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    // note：
    // 查询流粒度数据时，需同时传入 `App` 和 `Stream`。
    "Stream" => "example_stream",
    // 转码分辨率档位，默认为空表示不指定转码分辨率档位。以 720P 为例，表示转码配置的长边 x 短边计算而出的面积大于 480P（640 × 480）且小于等于 720P 档位（1280 x 720）。支持的取值和含义如下所示。
    // <li> `480P`：640 × 480； </li>
    // <li> `720P`：1280 × 720； </li>
    // <li> `1080P`：1920 × 1088； </li>
    // <li> `2K`：2560 × 1440； </li>
    // <li> `4K`：4096 × 2160； </li>
    // <li> `8K`：> 4096 x 2160； </li>
    // <li> `0P`：纯音频转码。 </li>
    "Resolution" => ["720P","1080P"], 
    // 查询数据的页码，默认为 1，表示查询第一页的数据。
    "PageNum" => 1,
    // 每页显示的数据条数，默认为 20，最大值为 100000。
    "PageSize" => 20,
    // 视频编码格式，默认为空表示不指定视频编码格式，支持的取值和含义如下所示。
    // <li> `Normal_H264`：H.264 标准转码； </li>
    // <li> `Normal_H265`：H.265 标准转码； </li>
    // <li> `Normal_H266`：H.266 标准转码； </li>
    // <li> `ByteHD_H264`：H.264 极智超清； </li>
    // <li> `ByteHD_H265`：H.265 极智超清； </li>
    // <li> `ByteHD_H266`：H.266 极智超清； </li>
    // <li> `ByteQE`：画质增强； </li>
    // <li> `Audio`：纯音频流。 </li>
    "TranscodeType" => ["Normal_H264","ByteHD_H265"], 
  ];

  $response = $client->describeLiveTranscodeInfoData($body);
  print_r($response);