1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
本接口用于访问日志的快速分析
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccessFastAnalysis。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
From | 是 | Integer | 要查询的日志的起始时间,Unix时间戳,单位ms 示例值:1625395948532 |
To | 是 | Integer | 要查询的日志的结束时间,Unix时间戳,单位ms 示例值:1626000748532 |
Query | 是 | String | 查询语句,语句长度最大为4096,由于本接口是分析接口,如果无过滤条件,必须传 * 表示匹配所有,参考CLS的分析统计语句的文档 示例值:"schema: http" |
FieldName | 是 | String | 需要分析统计的字段名 示例值:"method" |
Sort | 否 | String | 排序字段,升序asc,降序desc,默认降序desc 示例值:"desc" |
Count | 否 | Integer | 返回的top数,默认返回top5 示例值:5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FieldValueRatioInfos | Array of AccessFieldValueRatioInfo | 注意:此字段可能返回 null,表示取不到有效值 示例值:[{"Count":4451,"Ratio":0.7154798263944704,"Value":"bluehha.qcloudwaf.com"},{"Count":1687,"Ratio":0.2711782671596206,"Value":"qhy.17173.com"},{"Count":48,"Ratio":0.007715801318116058,"Value":"qqq323.qcloudwaf.com"},{"Count":20,"Ratio":0.003214917215881691,"Value":"0709.qcloudwaf.com"},{"Count":7,"Ratio":0.001125221025558592,"Value":"attack_log.qcloudwaf.com"},{"Count":7,"Ratio":0.001125221025558592,"Value":"bangskt.qcloudwaf.com"},{"Count":1,"Ratio":0.00016074586079408456,"Value":"zjm-mt.qcloudwaf.com"}] |
TotalCount | Integer | 日志条数 示例值:1000 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 访问日志快速分析
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessFastAnalysis
<公共请求参数>
{
"TopicId": "1ae37c76-df99-4e2b-998c-20f39eba6226",
"From": 1625395948532,
"To": 1626000748532,
"Query": "bot:1",
"FieldName": "host"
}
输出示例
{
"Response": {
"FieldValueRatioInfos": [
{
"Count": 4451,
"Ratio": 0.7154798263944704,
"Value": "bluehha.qcloudwaf.com"
},
{
"Count": 1687,
"Ratio": 0.2711782671596206,
"Value": "qhy.17173.com"
},
{
"Count": 48,
"Ratio": 0.007715801318116058,
"Value": "qqq323.qcloudwaf.com"
},
{
"Count": 20,
"Ratio": 0.003214917215881691,
"Value": "0709.qcloudwaf.com"
},
{
"Count": 7,
"Ratio": 0.001125221025558592,
"Value": "attack_log.qcloudwaf.com"
},
{
"Count": 7,
"Ratio": 0.001125221025558592,
"Value": "bangskt.qcloudwaf.com"
},
{
"Count": 1,
"Ratio": 0.00016074586079408456,
"Value": "zjm-mt.qcloudwaf.com"
}
],
"TotalCount": 7,
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.CLSInternalError | CLS内部错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidCertificate | 证书内容非法。 |
InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |