有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

日志审计日志查询

默认接口请求频率限制:5次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLogs。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
Index String 日志类型标识
流量日志:互联网边界防火墙netflow_border,NAT边界防火墙netflow_nat,VPC间防火墙vpcnetflow,内网流量日志netflow_fl
入侵防御日志rule_threatinfo
访问控制日志:互联网边界规则rule_acl,NAT边界规则rule_acl,内网间规则rule_vpcacl,企业安全组rule_sg
操作日志:防火墙开关-开关操作operate_switch,防火墙开关-实例配置operate_instance,资产中心操作operate_assetgroup,访问控制操作operate_acl,零信任防护操作operate_identity,入侵防御操作-入侵防御operate_ids,入侵防御操作-安全基线operate_baseline,常用工具操作operate_tool,网络蜜罐操作operate_honeypot,日志投递操作operate_logdelivery,通用设置操作operate_logstorage,登录日志operate_login
示例值:netflow_border
Limit Integer 每页条数,最大支持2000
示例值:10
Offset Integer 偏移值,最大支持60000
示例值:0
StartTime String 筛选开始时间
示例值:2021-09-21 12:00:00
EndTime String 筛选结束时间
示例值:2021-09-21 12:00:00
Filters.N Array of CommonFilter 过滤条件组合,各数组元素间为AND关系,查询字段名Name参考文档https://cloud.tencent.com/document/product/1132/87894,数值类型字段不支持模糊匹配

3. 输出参数

参数名称 类型 描述
Data String 日志列表
Total Integer 总条数
示例值:100
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: DescribeLogs
<公共请求参数>

{
    "Filters": [
        {
            "Name": "protocol",
            "Values": [
                "ANY",
                "TCP",
                "ICMP"
            ],
            "OperatorType": 1
        }
    ],
    "Limit": 10,
    "Offset": 0,
    "Index": "netflow_border",
    "StartTime": "2021-09-21 12:00:00",
    "EndTime": "2021-09-21 12:00:00"
}

输出示例

{
    "Response": {
        "Data": "[]",
        "RequestId": "e368c536-0331-46d3-b888-90c27152970f",
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "Total": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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