获取访问日志的下载链接--内容分发网络-火山引擎

文档中心

立即注册

导航

获取访问日志的下载链接

最近更新时间：2024.12.11 16:58:01首次发布时间：2021.07.15 11:09:03

获取指定加速域名的访问日志。该 API 返回的是这些访问日志的下载 URL。火山引擎内容分发网络（CDN）按小时在整点对访日日志进行打包。

使用限制

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

数据保留期限：CDN 保留自 2023年12月6日开始的日志。在调用该 API 时，建议您指定时间段的时间跨度不超过 30 天，不然可能由于日志数量庞大导致 API 调用超时。

日志时效性：打包的日志大约在 30 分钟后可以被下载。例如，对于 2021-07-07 11:00:00（含）- 2021/07/07 12:00:00（不含）的访问日志，CDN 在 2021-07-07- 12: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`：表示中国内地。 `global`：表示全球。 `outside_chinese_mainland`：表示全球（不包含中国内地）。该参数的默认值是 `chinese_mainland`。要指定 `global` 和 `outside_chinese_mainland`，您的加速域名必须已经开通这两个加速区域。要开通这两个加速区域，请提交工单。	`global`
StartTime	Long	是	表示日志统计时间段的开始时间，时间格式是 Unix 时间戳。 CDN 根据您指定的 `StartTime`，在小时粒度获取最接近 `StartTime` 的一个较晚的时间，作为实际的日志统计时间段的开始时间。例子：您指定的 `StartTime` 为 `1707537715`，`EndTime` 为 `1707544915`。`StartTime` 表示 2024-12-10 04:01:55 UTC，`EndTime` 表示 2024-12-10 06:01:55 UTC。在这个情况下，实际日志统计时间段是 2024-12-10 05:00:00 - 2024-12-10 07:00:00。CDN 提供两个日志包供您下载，这两个日志包所包含的分别是 [5:00-6:00) 和 [6:00-7:00) 这两个小时段的日志。	`1641844915`
EndTime	Long	是	表示日志统计时间段的结束时间，时间格式是 Unix 时间戳。 CDN 根据您指定的 `EndTime`，在小时粒度获取最接近 `EndTime` 的一个较晚的时间，作为实际的日志统计时间段的结束时间。	`1641953589`
PageNum	Long	否	表示一个页码。该 API 返回的是该页码所指定的分页上的那些日志包。该 API 返回的日志包是根据 `PageSize` 而分页的。假设该 API 返回的日志包数量是 100，您指定的 `PageSize` 是 `10`，那么返回的日志包是分布在 10 个页上。如果您指定的 `PageNum` 是 `2`，表示获取第 2 页上的那些日志包。如果您指定的分页上没有日志包，则返回结果中 `DomainLogDetails` 参数的值为 `null`。 `PageNum` 的默认值是 `1`。	`1`
PageSize	Long	否	表示每个分页包含的日志包数量。该参数的取值范围是 1-100，默认值是 `10`。	`1`

返回参数

参数名称	数据类型	参数说明	示例
Domain	String	表示请求参数中的 `Domain`。	`www.a.com`
PageSize	Long	表示请求参数中的 `PageSize`。	`100`
PageNum	Long	表示请求参数中的 `PageNum`。	`1`
TotalCount	Long	表示符合过滤条件的日志包数量。	`100`
DomainLogDetails	Object[]	表示该 API 返回的日志包列表。

请求示例

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": "URL1",
        "LogSize": 274247,
        "StartTime": 1672984800
      },
      {
        "EndTime": 1672988400,
        "LogName": "www.example.com_20230106140000_20230106150000_outsideChineseMainland.gz",
        "LogPath": "URL2",
        "LogSize": 1534,
        "StartTime": 1672984800
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 14
  }
}

错误码

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