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

获取访问日志的下载链接

最近更新时间2024.03.19 15:48:27

首次发布时间2021.07.15 11:09:03

通过 API 请求查询域名访问日志的下载链接。

使用限制

节流限制:您每秒最多可以发送 20 个 API 请求。

数据保留期限:系统保留最近 62 天的访问数据。另外,查询时间范围建议不超过 30 天。

数据时效性:日志数据按小时在整点打包,打包后的日志大约在 3 小时后可以被下载。例如 2021/07/07 11:00:00-2021/07/07 11:59:59 的数据在 2021/07/07/ 12:00:00 打包,在 15:00:00 可以被下载。但是由于网络延时等原因,日志包中的日志在打包后的 24 小时内还可能会有追加。

请求说明

  • 请求方式:POST
  • 请求地址:https://cdn.volcengineapi.com/?Action=DescribeCdnAccessLog&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
接口名称。当前 API 的名称为 DescribeCdnAccessLog
Version
String
接口版本。当前 API 的版本为 2021-03-01

Body

参数名称
数据类型
是否必选
参数说明
示例
Domain
String
指定一个加速域名。API 返回的是该加速域名的日志。
www.example.com
ServiceRegion
String

指定一个加速区域对日志进行过滤。该参数仅当您通过提交工单启用了 中国内地 以外的加速区域时才有效。

该参数有以下取值:

  • chinese_mainland:表示获取访问请求是来自 中国内地 的日志。查询返回的日志包的名称不包含 outsideChineseMainland
  • global:表示获取访问请求是来自 全球 的日志。
  • outside_chinese_mainland:表示获取访问请求是来自 全球(不含中国内地) 的日志。查询返回的日志包的名称包含 outsideChineseMainland
该参数的默认值是 global
global
StartTime
Long

指定一个开始时间对日志进行过滤,时间格式是 Unix 时间戳。

例子1:您指定 StartTime1641844915,代表 2022-01-11 04:01:55 UTC。此时,日志统计时间段是从 05:00:00 开始。如果某个统计时间段没有用户请求,该时间段就没有日志可下载。

StartTimeEndTime 之间的时间范围不能大于 62 天。另外,建议您指定的时间范围不超过 30 天。
1641844915
EndTime
Long

指定一个结束时间对日志进行过滤,时间格式是 Unix 时间戳。

例子1:您指定 EndTime1641953589,代表 2022-01-12 10:13:09 UTC。此时,日志统计的结束时间是 05:00:00,不包含 05:00:00 这个时间点。如果某个统计时间段没有用户请求,该时间段就没有日志可下载
1641953589
PageNum
Long

指定一个页码。系统只返回该页面上的那些日志包。

默认值为 1。如果指定的页码不存在,则返回空值。建议第一次提交查询时使用默认值。您可以根据响应正文中的 TotalCountPageSize 参数的值计算结果页数。然后再查询中指定一个 PageNum 来获取该页面上的那些日志包。
1
PageSize
Long

指定查询结果中每页包含的日志包数量。

默认值是 10,最大值是 100
1

响应正文

参数名称
数据类型
参数说明
示例
Domain
String
指定的加速域名。
www.a.com
PageSize
Long
指定的每页条数 。
100
PageNum
Long
指定的页码。
1
TotalCount
Long
日志包总数。
100
DomainLogDetails
Object[]
日志详情

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeCdnAccessLog&Version=2021-03-01
{
  "PageSize": 10,
  "PageNum": 1,
  "Domain": "www.example.com",
  "StartTime": 1672963200,
  "EndTime": 1672990980,
  "ServiceRegion": "global"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230106154654C2A5B7CAC58210677DED",
    "Action": "DescribeCdnAccessLog",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "Domain": "www.example.com",
    "DomainLogDetails": [
      {
        "EndTime": 1672988400,
        "LogName": "www.example.com_20230106140000_20230106150000.gz",
        "LogPath": "https://cdnlog.bytedance.com/cdn-openapi/userlog/file-download/v1?fileName=www.example.com_20230106140000_20230106150000.gz&accountId=2100003464&token=c206220d9edb78e48737660483bcc1910d41013cad0c01cf8bbe576c2d84838521731d7cdd382d88ae4c8c66e6c186958fd16c457071ea1daea4a5d68a7c8047",
        "LogSize": 274247,
        "StartTime": 1672984800
      },
      {
        "EndTime": 1672988400,
        "LogName": "www.example.com_20230106140000_20230106150000_outsideChineseMainland.gz",
        "LogPath": "https://cdnlog.bytedance.com/cdn-openapi/userlog/file-download/v1?fileName=www.example.com_20230106140000_20230106150000_outsideChineseMainland.gz&accountId=2100003464&token=c206220d9edb78e48737660483bcc1910d41013cad0c01cf8bbe576c2d84838521731d7cdd382d88ae4c8c66e6c186958fd16c457071ea1daea4a5d68a7c8047",
        "LogSize": 1534,
        "StartTime": 1672984800
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 14
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。更多关于错误码的信息,参见错误码