You need to enable JavaScript to run this app.
导航

查询日志文件信息

最近更新时间2024.01.26 17:15:38

首次发布时间2023.10.25 18:04:53

调用 DescribeLiveLogData 接口,查询日志文件信息。

使用说明

  • 支持查询指定域名(包含已删除域名)下产生的拉流日志、推流日志、回源日志和拉流转推日志文件信息,日志格式说明请参见日志管理
  • 日志文件按小时粒度分割,单个日志文件日志上限为 150 万条,超过 150 万条时会生成新的日志文件。
  • 当前仅支持查询最近 31 天的日志数据。

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 1 小时

请求说明

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

调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

StartTime

String

2022-04-13T10:00:00+08:00

查询的开始时间,RFC3339 格式的 UTC 时间,精度为秒。

说明

当前仅支持查询最近 31 天的日志数据。

EndTimeString2022-04-13T11:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为秒。

DomainList

Array of String

["example.com","example2.com"]

域名列表,缺省情况下表示当前用户的所有推流域名和拉流域名。

说明

日志类型为拉流转推日志(Type=relay)时,该参数无效。

Type

String

pull

日志类型,支持的类型如下所示。

  • pull:拉流日志
  • push:推流日志
  • source:回源日志
  • relay:拉流转推日志
PageNumInteger1查询数据的页码,默认为 1,表示查询第一页的数据。
PageSizeInteger20每页显示的数据条数,默认为 20,最大值为 1000。

返回参数

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

参数类型示例值描述
StartTimeString2022-04-13T10:00:00+08:00查询的开始时间,RFC3339 格式的 UTC 时间,精度为秒。
EndTimeString2022-04-13T11:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为秒。
DomainListArray of String["exanple.com","example2.com"]域名列表。

Type

String

pull

日志类型,类型说明如下所示。

  • pull:拉流日志
  • push:推流日志
  • source:回源日志
  • relay:拉流转推日志
PaginationObject of Pagination-数据分页信息。
LogInfoListArray of LogInfoList-日志文件的信息列表。

Pagination

参数类型示例值描述
PageNumInteger1当前所在分页的页码。
PageSizeInteger20每页显示的数据条数。
TotalCountInteger123查询结果的数据总条数。

LogInfoList

参数类型示例值描述

Domain

String

example.com

域名。

说明

查询拉流转推日志(Type=relay)时,该字段为空。

LogName

String

example.com_2023_09_01_000000_010000_0.gz

日志文件名称,日志文件命名规则如下。

  • 与域名相关时:加速域名_年_月_日_时间开始_时间结束_文件拆分序号。例如,www.example.com_2023_08_11_000000_010000_0.gz
  • 与域名无关时:年_月_日_时间开始_时间结束_文件拆分序号。例如,2023_08_11_000000_010000_0.gz
  • 如果某个小时内,当前事件产生的日志大于 150 万条,则会生成为多个日志文件,用文件名最后的序号标注日志文件顺序,例如,2023_08_11_000000_010000_0.gz2023_08_11_000000_010000_1.gz
LogSizeInteger12日志文件大小,单位为 byte。
DateTimeString2022-04-13T00:00:00+08:00日志文件对应的小时区间,RFC3339 格式的 UTC 时间,精度为秒。
DownloadUrlStringhttp://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": [
    "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": "example.com",
        "DownloadUrl": "http://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
    }
  }
}

错误码

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

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

服务端 SDK

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