查询离线日志下载地址--veImageX-火山引擎

文档中心

立即注册

导航

查询离线日志下载地址

最近更新时间：2024.01.31 15:20:02首次发布时间：2023.02.01 13:36:21

本接口支持通过指定服务 ID 、域名和地域等获取查询离线日志下载链接。您可通过下载链接获取离线日志，日志字段说明请参考日志字段说明与示例。

使用限制

每秒最多可提交 10 个 API 请求。
系统仅保留最近 30 天的访问数据，您无法查询并获取 30 天前的访问数据。
查询数据的时间粒度为一小时。
日志数据按小时整点打包，打包后的日志大约在 30 分钟后可以被下载。但由于网络延时等原因，打包后日志包内数据可能会不断追加，一般在 24 小时左右趋于稳定。例如 2021/07/07 11:00:00-2021/07/07 11:59:59 的数据在 2021/07/07/ 12:00:00 打包，在 2021/07/07/ 12:30:00 后可提供下载。

请求说明

接口名称：DescribeImageVolcCdnAccessLog
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageVolcCdnAccessLog&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	描述
Domain	String	是	域名，您可以通过获取服务下全部域名获取服务下域名信息。
Region	String	是	地域。支持以下取值： chinese_mainland：中国大陆，返回的日志包的名称不包含 outsideChineseMainland； global：全球； outside_chinese_mainland：全球（除中国大陆），返回的日志包的名称包含 outsideChineseMainland。说明该参数仅当您启用了中国大陆外加速区域时，配置才会生效，否则仅返回国内日志数据。您可以登录 veImageX 控制台参考域名配置 > 高级配置开启全球加速，两个工作日左右全球加速启用生效。全球加速功能为 veImageX 计费项，具体计费详情请参考后付费-按量计费。
StartTime	Integer	是	查询日志开始时间戳，Unix 时间，单位为秒。例如：指定起始时间为`1641844915`，代表 2022-01-11 04:01:55 UTC。在查询返回的日志列表中，第一个统计在内的日志包名称是domain_20220111050000_20220111060000.gz。该日志包中包含该域名在 05:00:00 和 05:59:59 之间的访问日志。 StartTime 和 EndTime 之间的时间范围不能大于 30 天。
EndTime	Integer	是	查询日志结束时间戳，Unix 时间，单位为秒。例如：指定结束时间为`1641953589`，代表 2022-01-12 10:13:09 UTC。在查询返回的日志列表中，最后一个统计在内的日志包名称是 domain_20220112100000_20220112110000.gz。该日志包中包含该域名在 10:00:00 和 10:59:59 之间的访问日志。 StartTime 和 EndTime 之间的时间范围不能大于 30 天。
PageNum	Integer	是	指定的页码，系统只返回该页面上的日志包数据。起始值为 `1`，如果指定页码不存在，则返回空值。说明建议第一次提交查询时指定页码为 1。您可以根据响应正文中的`TotalCount`和`PageSize`参数的值计算结果页数。之后在查询中指定`PageNum`来获取该页面上日志包。
PageSize	Integer	是	指定查询结果中每页包含的日志包数量。取值范围为 [10, 100]。

返回参数

参数	类型	描述
Domain	String	加速域名。
PageSize	Integer	指定的每页日志包数量。
PageNum	Integer	指定的页码数。
TotalCount	Integer	日志包总数。
Logs	Array of Logs	查询的日志数据。

Logs

参数	类型	描述
StartTime	Integer	日志起始时间。
EndTime	Integer	日志结束时间。
LogName	String	日志包名称。
LogPath	String	日志包下载地址，下载链接有效时间为 10 分钟。
LogSize	Integer	日志包大小，单位为 byte。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageVolcCdnAccessLog&Version=2018-08-01&ServiceId=ylqndedkyn 
{
    "Domain": "a8****x8",
    "Region": "global",
    "StartTime": 1672963200,
    "EndTime": 1672990980,
    "PageNum": 220,
    "PageSize": 336
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageVolcCdnAccessLog",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domain": "a8****x8",
        "PageSize": 645,
        "PageNum": 690,
        "TotalCount": 486,
        "Logs": [
            {
                "StartTime": 1672963200,
                "EndTime": 1672990980,
                "LogName": "www.example.com_20230106140000_20230106150000.gz",
                "LogPath": "http://test.com",
                "LogSize": 937
            },
            {
                "StartTime": 1672984800,
                "EndTime": 1672988400,
                "LogName": "www.example.com_20230106140000_20230106150000_outsideChineseMainland.gz",
                "LogPath": "http://test1.com",
                "LogSize": 1534                
            }           
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageVolcCdnAccessLog",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问公共错误码和域名相关错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：