DescribeLiveLogData - 查询日志文件信息--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveLogData - 查询日志文件信息

最近更新时间：2024.12.09 11:16:50首次发布时间：2023.10.25 18:04:53

调用 DescribeLiveLogData 接口，查询指定时间范围内指定日志类型的离线日志文件及下载信息。

注意事项

使用限制：
- 支持查询指定域名（包含已删除域名）下产生的日志文件信息。
- 支持查询最近 31 天内产生的日志数据。
- 支持查询日志打包文件的信息，各类型日志格式说明请参见日志管理。
请求频率：单用户请求频率限制为 100 次/秒。
数据延迟：数据延迟为 1 小时。
日志回补：日志文件打包存在延迟，且日志包内容会进行追加补充，最长 24 小时后可获取最完整的日志文件。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLiveLogData&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLiveLogData`	接口名称。当前 API 的名称为 `DescribeLiveLogData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
StartTime	String	是	`2022-04-13T10:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明当前仅支持查询最近 31 天的日志数据。日志文件以整小时进行拆分，请确保查询的开始和结束时间包含所查询时段的整点小时时间。例如，如需查询某日 07:30:00-08:10:00 日志数据，日志查询开始时间应早于 07:00:00，结束时间应晚于 09:00:00。
EndTime	String	是	`2022-04-13T11:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
DomainList	Array of String	否	`["push.example.com","pull.example.com"]`	域名列表，默认为空，表示查询您视频直播产品下所有域名的日志文件信息。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名。说明日志类型为拉流转推日志（Type 取值为 `relay`）时，该参数无效。
Type	String	是	`pull`	日志类型，支持的类型如下所示。 `pull`：拉流日志； `push`：推流日志； `source`：回源日志； `relay`：拉流转推日志。
PageNum	Integer	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
PageSize	Integer	否	`20`	每页显示的数据条数，默认为 20，最大值为 1000。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
StartTime	String	`2022-04-13T10:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-04-13T11:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
DomainList	Array of String	`["push.exanple.com","pull.example.com"]`	域名列表。
Type	String	`pull`	日志类型，类型说明如下所示。 `pull`：拉流日志 `push`：推流日志 `source`：回源日志 `relay`：拉流转推日志
Pagination	Object of Pagination	`-`	数据分页信息。
LogInfoList	Array of LogInfoList	`-`	日志文件的信息列表。

Pagination

参数	类型	示例值	描述
PageNum	Integer	`1`	当前所在分页的页码。
PageSize	Integer	`20`	每页显示的数据条数。
TotalCount	Integer	`123`	查询结果的数据总条数。

LogInfoList

参数	类型	示例值	描述
Domain	String	`pull.example.com`	域名。说明查询拉流转推日志（Type 取值为 `relay`）时，该字段为空。
LogName	String	`pull.example.com_2023_09_01_000000_010000_0.gz`	日志文件名称，日志文件命名规则如下。与域名相关时：加速域名_年_月_日_时间开始_时间结束_文件拆分序号。例如，`push.example.com_2023_08_11_000000_010000_0.gz`；与域名无关时：年_月_日_时间开始_时间结束_文件拆分序号。例如，`2023_08_11_000000_010000_0.gz`；说明如果某个小时内，当前事件产生的日志大于 150 万条，则会生成为多个日志文件，用文件名最后的序号标注日志文件顺序，例如，`2023_08_11_000000_010000_0.gz`、`2023_08_11_000000_010000_1.gz`。
LogSize	Integer	`12`	日志文件大小，单位为 byte。
DateTime	String	`2022-04-13T00:00:00+08:00`	日志文件对应的小时区间，RFC3339 格式的时间戳，精度为秒。
DownloadUrl	String	`http://push.example.com/download/20230901/example.com_2023_09_01_000000_010000_0.gz?x-expires=1693918129`	日志文件下载链接。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveLogData&Version=2023-01-01
{
  "StartTime": "2023-09-01T00:00:00+08:00",
  "EndTime": "2023-09-01T23:00:00+08:00",
  "Type": "pull",
  "DomainList": [
    "pull.example.com"
  ],
  "PageSize": 20,
  "PageNum": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "DescribeLiveLogData",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "StartTime": "2023-09-01T00:00:00+08:00",
    "EndTime": "2023-09-01T23:00:00+08:00",
    "Type": "pull",
    "LogInfoList": [
      {
        "DateTime": "2023-09-01T22:00:00+08:00",
        "Domain": "pull.example.com",
        "DownloadUrl": "http://pull.example.com/download/20230901/example.com_2023_09_01_000000_010000_0.gz?x-expires=1693918129",
        "LogName": "example.com_2023_09_01_000000_010000_0.gz",
        "LogSize": 24900
      }
    ],
    "Pagination": {
      "PageNum": 1,
      "PageSize": 1,
      "TotalCount": 1
    }
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。