搜索访问日志
最近更新时间: 2024-10-18 10:38:35
1. 接口描述
接口请求域名: ngwaf.api3.fincloud.tencent.cn。
本接口用于搜索WAF访问日志
默认接口请求频率限制:10次/秒。
接口更新时间:2023-12-12 15:23:06。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:SearchAccessLog |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-01-25 |
Region | 是 | 否 | String | 公共参数,本接口不需要传递此参数。 |
Page | 否 | 否 | Int64 | 此参数对外不可见。 第几页,从0开始。新版本接口字段 |
TopicId | 是 | 否 | String | 此参数对外不可见。 客户要查询的日志主题ID,每个客户都有对应的一个主题,新版本此字段填空字符串 |
From | 是 | 否 | Int64 | 此参数对外不可见。 要查询的日志的起始时间,Unix时间戳,单位ms |
To | 是 | 否 | Int64 | 此参数对外不可见。 要查询的日志的结束时间,Unix时间戳,单位ms |
Query | 是 | 否 | String | 此参数对外不可见。 查询语句,语句长度最大为4096 |
Limit | 否 | 否 | Int64 | 此参数对外不可见。 单次查询返回的日志条数,最大值为100 |
Context | 否 | 否 | String | 此参数对外不可见。 新版本此字段失效,填空字符串,翻页使用Page |
Sort | 否 | 否 | String | 此参数对外不可见。 日志接口是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Context | String | 此参数对外不可见。 新接口此字段失效,默认返回空字符串 |
ListOver | Bool | 此参数对外不可见。 日志查询结果是否全部返回,其中,“true”表示结果返回,“false”表示结果为返回 |
Analysis | Bool | 此参数对外不可见。 返回的是否为分析结果,其中,“true”表示返回分析结果,“false”表示未返回分析结果 |
ColNames | String | 此参数对外不可见。 如果Analysis为True,则返回分析结果的列名,否则为空<br>注意:此字段可能返回 null,表示取不到有效值。 |
Results | AccessLogInfo | 此参数对外不可见。 日志查询结果;当Analysis为True时,可能返回为null<br>注意:此字段可能返回 null,表示取不到有效值 |
AnalysisResults | AccessLogItems | 此参数对外不可见。 日志分析结果;当Analysis为False时,可能返回为null<br>注意:此字段可能返回 null,表示取不到有效值 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
InvalidParameterValue | |
MissingParameter | |
UnknownParameter | |
InternalError | |
UnauthorizedOperation | |
ResourceNotFound | |
LimitExceeded | |
ResourceUnavailable | |
ResourceInsufficient | |
FailedOperation | |
ResourceInUse | |
ResourcesSoldOut | |
InvalidParameter.InvalidCertificate | |
InvalidParameter.QueryCertBySSLIDFailed | |
UnsupportedOperation | |
AuthFailure | |
RequestLimitExceeded | |
OperationDenied | |
FailedOperation.CLSInternalError | |
InternalError.DBErr | |
InvalidParameter.QueryStringSyntaxErr | |
InvalidParameter.TypeMismatch | |
InvalidParameter.LogicErr | |
InternalError.UnknownErr |