云防火墙日志审计日志离线导出

1. 接口描述

接口请求域名： cfw.tencentcloudapi.com 。

日志审计日志离线导出

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ExportLogsOffline。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
Index	是	String	日志类型标识枚举值： cfw_netflow_border：流量日志-互联网边界 cfw_netflow_vpc：流量日志-VPC边界 cfw_netflow_nat：流量日志-NAT边界 cfw_rule_acl：访问控制-互联网边界 cfw_rule_vpc_acl：访问控制-VPC边界 cfw_rule_nat_acl：访问控制-NAT边界 cfw_rule_threatinfo：入侵防御-入侵防御 cfw_netflow_nta：全流量检测与响应-流量分析 cfw_ndr_subject_risk：全流量检测与响应-流量风险 cfw_ndr_ai_audit：全流量检测与响应-AI流量风险 operate_log_all：操作日志示例值：cfw_netflow_border
StartTime	是	String	筛选开始时间示例值：2021-09-21 12:00:00
EndTime	是	String	筛选结束时间示例值：2021-09-21 12:00:00
TaskName	是	String	任务名称示例值：流量日志导出
DataFormat	是	String	数据格式枚举值： .json： JSON格式 .csv： CSV格式示例值：.json
CompressionFormat	是	String	压缩方式，.zip、.tar.gz、.tar.zst、.tar.lz4、传空不压缩示例值：.zip
Order	是	String	日志排序，desc时间降序，asc时间升序示例值：desc
Length	是	Integer	日志数量，传0按单次上限导出示例值：0
Filters.N	否	Array of CommonFilter	过滤条件组合
BucketName	否	String	COS存储桶名称示例值：guangzhou-bucket
BucketRegion	否	String	COS存储桶地域示例值：ap-guangzhou
StorageDays	否	Integer	文件过期时长，1一天，7七天，-1永久示例值：7
Query	否	String	日志分析查询语句，Query和Filters不能同时使用，在一次请求中有且只能选择一个示例值：protocol:HTTP
TaskType	否	String	导出任务类型，LogAnalysis日志分析导出，LogSearch日志审计导出示例值：LogAnalysis

3. 输出参数

参数名称	类型	描述
ReturnCode	Integer	返回状态码 0 成功非0不成功示例值：0
ReturnMsg	String	返回信息 success 成功其他不成功示例值：success
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 日志分析日志离线导出

日志分析日志离线导出

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportLogsOffline
<公共请求参数>

{
    "Index": "cfw_netflow_border",
    "TaskType": "LogAnalysis",
    "Query": "protocol:HTTP",
    "StartTime": "2023-01-01 00:00:00",
    "EndTime": "2023-01-01 23:59:59",
    "TaskName": "导出日志",
    "DataFormat": ".json",
    "CompressionFormat": ".zip",
    "Order": "desc",
    "Length": 100
}

输出示例

{
    "Response": {
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "RequestId": "b12dee5f-bca2-49bc-88c1-a838c7b93089"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。