搜索访问日志

最近更新时间:2024-11-05 02:30:46

我的收藏

1. 接口描述

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

本接口用于搜索WAF访问日志

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SearchAccessLog。
Version String 公共参数,本接口取值:2018-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。
TopicId String 客户要查询的日志主题ID,每个客户都有对应的一个主题,新版本此字段填空字符串
示例值:"1ae37c76-df99-4e2b-998c-20f39eba6226"
From Integer 要查询的日志的起始时间,Unix时间戳,单位ms
示例值:1625395948532
To Integer 要查询的日志的结束时间,Unix时间戳,单位ms
示例值:1626000748532
Query String 查询语句,语句长度最大为4096
示例值:"schema: http"
Limit Integer 单次查询返回的日志条数,最大值为100
示例值:100
Context String 新版本此字段失效,填空字符串,翻页使用Page
示例值:"Y29udGV4dC1mMTE4NWE2My1mZTBmLTQ2YTctOTQzOS0zMzFlNGU2Y2EzYTAxNjI
Sort String 日志接口是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
示例值:"desc"
Page Integer 第几页,从0开始。新版本接口字段
示例值:1

3. 输出参数

参数名称 类型 描述
Context String 新接口此字段失效,默认返回空字符串
示例值:"Y29udGV4dC04ZWEyOGZlNi0zOTc1LTRmMGUtYTQzNy02OWU4MWQ5NzJkODkxNj"
ListOver Boolean 日志查询结果是否全部返回,其中,“true”表示结果返回,“false”表示结果为返回
示例值:false
Analysis Boolean 返回的是否为分析结果,其中,“true”表示返回分析结果,“false”表示未返回分析结果
示例值:false
Results Array of AccessLogInfo 日志查询结果;当Analysis为True时,可能返回为null
注意:此字段可能返回 null,表示取不到有效值
示例值:[{"Time": 1730207183000,"LogJson": ""}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 搜索访问日志

搜索访问日志

输入示例

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

{
    "TopicId": "1ae37c76-df99-4e2b-998c-20f39eba6226",
    "From": 1625395948532,
    "To": 1626000748532,
    "Query": "bot:1",
    "Limit": 2,
    "Context": "cont",
    "Sort": "desc"
}

输出示例

{
    "Response": {
        "Context": "Y29udGV4dC1jMDhiYjAyMy1mMjZmLTQ1NjUtOTEzMy1iZjIwYWUzNmY1MzMxNjI2MTU5NDU4MjQy",
        "ListOver": false,
        "Analysis": false,
        "Results": [
            {
                "PkgLogId": "pkg-log-id",
                "FileName": "name",
                "PkgId": "pkg-id",
                "Source": "src",
                "TopicName": "name",
                "Time": 1625995282703,
                "TopicId": "1ae37c76-df99-4e2b-998c-20f39eba6226",
                "LogJson": "{\"ipinfo_province\":\"共享地址\",\"schema\":\"http\",\"referer\":\"\",\"ipinfo_state\":\"\",\"ipinfo_city\":\"\",\"edition\":\"sparta-waf\",\"ipinfo_dimensionality\":\"\",\"language\":\"\",\"body\":\"\",\"uuid\":\"b285a612f62f5b76478fce8960d2327e-c613c8e835f1d2a48221efa4a21c4247\",\"upstream_status\":\"200\",\"request_time\":\"0.141\",\"content_type\":\"\",\"host\":\"bangskt.qcloudwaf.com\",\"client\":\"100.88.193.73\",\"connection\":\"\",\"ipinfo_nation\":\"共享地址\",\"user_agent\":\"TSecWaf_AccessCheckClient\",\"headers\":\"Accept-Encoding: \",\"upstream\":\"119.29.90.203:80\",\"cookie\":\"\",\"method\":\"GET\",\"query\":\"\",\"ipinfo_detail\":\"\",\"encoding\":\"\",\"ipinfo_isp\":\"\",\"bytes_sent\":\"718\",\"url\":\"/\",\"accept\":\"\",\"x_forwarded_for\":\"\",\"upstream_connect_time\":\"0.036\",\"request_length\":\"86\",\"appid\":\"251011484\",\"domain\":\"bangskt.qcloudwaf.com\",\"msec\":\"1625995282.703\",\"upstream_response_time\":\"0.068\",\"time\":\"11/Jul/2021:17:21:22 +0800\",\"ipinfo_longitude\":\"\",\"status\":\"200\"}"
            }
        ],
        "RequestId": "9b02bf9e-c89c-42c3-9ae1-685f968fa02d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.CLSInternalError CLS内部错误。
InternalError 内部错误。
InternalError.DBErr DBErr
InternalError.UnknownErr 存在内部错误,请联系我们
InvalidParameter 参数错误。
InvalidParameter.InvalidCertificate 证书内容非法。
InvalidParameter.LogicErr 逻辑错误:SQL检索语句中的逻辑错误也可能导致错误。例如,使用错误的运算符、使用错误的条件等
InvalidParameter.QueryCertBySSLIDFailed 根据ID查询证书失败。
InvalidParameter.QueryStringSyntaxErr 语法错误:逻辑表达式语法解析出错
InvalidParameter.TypeMismatch 数据类型错误:SQL检索语句中的数据类型必须与数据库中的数据类型匹配,否则会导致错误。例如,将字符串与整数进行比较、将日期格式不正确等。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。