You need to enable JavaScript to run this app.
导航
日志管理
最近更新时间:2024.09.14 11:16:48首次发布时间:2023.12.28 21:21:51

阅读本文,您可以获取 PHP SDK 日志管理的接口调用示例,实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍日志管理相关接口的功能和调用示例。

查询日志文件信息

您可以调用 DescribeLiveLogData 接口查询日志文件信息。详细的参数说明可参见 DescribeLiveLogData 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

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

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

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

$body = [
    // 查询的开始时间,RFC3339 格式的时间戳,精度为秒。
    // note:
    // <li> 当前仅支持查询最近 31 天的日志数据。 </li>
    // <li> 日志文件以整小时进行拆分,请确保查询的开始和结束时间包含所查询时段的整点小时时间。例如,如需查询某日 07:30:00-08:10:00 日志数据,日志查询开始时间应早于 07:00:00,结束时间应晚于 09:00:00。 </li>
    "StartTime" => "2022-04-13T10:00:00+08:00",
    // 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
    "EndTime" => "2022-04-13T11:00:00+08:00",
    // 域名列表,默认为空,表示查询您视频直播产品下所有域名的日志文件信息。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,获取待查询的域名。
    // note:
    // 日志类型为拉流转推日志(Type 取值为 relay)时,该参数无效。
    "DomainList" => ["push.example.com", "pull.example.com"],
    // 日志类型,支持的类型如下所示。
    // <li> pull:拉流日志; </li>
    // <li> push:推流日志; </li>
    // <li> source:回源日志; </li>
    // <li> relay:拉流转推日志。 </li>
    "Type" => "pull",
    // 查询数据的页码,默认为 1,表示查询第一页的数据。
    "PageNum" => 1,
    // 每页显示的数据条数,默认为 20,最大值为 1000。
    "PageSize" => 20,
];

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