配置指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

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

Waf统计数据查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWafData。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 查询起始时间,如:2018-09-04 10:40:00,返回结果大于等于指定时间
EndTime String 查询结束时间,如:2018-09-04 10:40:00,返回结果小于等于指定时间
Interval String 时间粒度,支持以下几种模式:
min:1 分钟粒度,指定查询区间 24 小时内(含 24 小时),可返回 1 分钟粒度明细数据
5min:5 分钟粒度,指定查询区间 31 天内(含 31 天),可返回 5 分钟粒度明细数据
hour:1 小时粒度,指定查询区间 31 天内(含 31 天),可返回 1 小时粒度明细数据
day:天粒度,指定查询区间大于 31 天,可返回天粒度明细数据

仅支持30天内数据查询,且查询时间范围在 7 到 30 天最小粒度是 hour。
Domain String 指定域名查询
AttackType String 指定攻击类型
不填则查询所有攻击类型的数据分布
AttackType 映射如下:
"webshell" : Webshell检测防护
"oa" : 常见OA漏洞防护
"xss" : XSS跨站脚本攻击防护
"xxe" : XXE攻击防护
"webscan" : 扫描器攻击漏洞防护
"cms" : 常见CMS漏洞防护
"upload" : 恶意文件上传攻击防护
"sql" : SQL注入攻击防护
"cmd_inject": 命令/代码注入攻击防护
"osc" : 开源组件漏洞防护
"file_read" : 任意文件读取
"ldap" : LDAP注入攻击防护
"other" : 其它漏洞防护
DefenceMode String 指定防御模式
不填则查询所有防御模式的数据总和
DefenceMode映射如下:
observe = '观察模式'
intercept = '拦截模式'
Area String 地域:mainland 或 overseas
AttackTypes.N Array of String 指定多个攻击类型,取值参考AttackType
Domains.N Array of String 指定域名列表查询

3. 输出参数

参数名称 类型 描述
Data Array of TimestampData 粒度数据
Interval String 粒度
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Waf统计数据查询

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeWafData
&Domain=www.test.com
&StartTime=2019-06-11 00:00:00
&EndTime=2019-06-11 23:59:59
&Interval=hour
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "d9b58c40-562c-4ac1-8aea-755547beefa3",
        "Data": [
            {
                "Time": "2019-06-26 00:00:00",
                "Value": 0
            },
            {
                "Time": "2019-06-26 01:00:00",
                "Value": 1
            },
            {
                "Time": "2019-06-26 02:00:00",
                "Value": 2
            },
            {
                "Time": "2019-06-26 03:00:00",
                "Value": 9
            },
            {
                "Time": "2019-06-26 04:00:00",
                "Value": 0
            }
        ],
        "Interval": "hour"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.DataSystemError 数据查询错误,请联系腾讯云工程师进一步排查。
InternalError.ProxyServer 内部服务错误,请联系腾讯云工程师进一步排查。
InternalError.SystemDBError 内部数据错误,请重试或联系客服人员解决。
InvalidParameter.CDNStatusInvalidDomain 域名状态不合法。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例。
InvalidParameter.CdnStatInvalidFilter 统计维度不合法,请参考文档中统计分析示例。
InvalidParameter.CdnStatInvalidMetric 统计类型不合法,请参考文档中统计分析示例。
InvalidParameter.ParamError 参数错误。
ResourceNotFound.CdnHostNotExists 未查询到该域名,请确认域名是否正确。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnAccountUnauthorized 子账号禁止查询整体数据。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.DomainEmpty 鉴权域名为空。
UnauthorizedOperation.NoPermission 未授权的操作。
目录