内容分发网络 CDN 获取SCDN的Top数据-API 文档-文档中心-腾讯云

1. 接口描述

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

获取SCDN的Top数据

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeScdnTopData。
Version	是	String	公共参数，本接口取值：2018-06-06。
Region	否	String	公共参数，本接口不需要传递此参数。
StartTime	是	Timestamp	查询起始时间，如：2018-09-04 10:40:00，返回结果大于等于指定时间
EndTime	是	Timestamp	查询结束时间，如：2018-09-04 10:40:00，返回结果小于等于指定时间
Mode	是	String	查询的SCDN TOP攻击数据类型： waf：Web 攻击防护TOP数据
Metric	是	String	排序对象，支持以下几种形式： url：攻击目标 url 排序 ip：攻击源 IP 排序 attackType：攻击类型排序
Filter	是	String	排序使用的指标名称： request：请求次数
Domain	否	String	指定域名查询
AttackType	否	String	指定攻击类型, 仅 Mode=waf 时有效不填则查询所有攻击类型的数据总和 AttackType 映射如下: other = '未知类型' malicious_scan = "恶意扫描" sql_inject = "SQL注入攻击" xss = "XSS攻击" cmd_inject = "命令注入攻击" ldap_inject = "LDAP注入攻击" ssi_inject = "SSI注入攻击" xml_inject = "XML注入攻击" web_service = "WEB服务漏洞攻击" web_app = "WEB应用漏洞攻击" path_traversal = "路径跨越攻击" illegal_access_core_file = "核心文件非法访问" trojan_horse = "木马后门攻击" csrf = "CSRF攻击" malicious_file_upload= '恶意文件上传'
DefenceMode	否	String	指定防御模式,仅 Mode=waf 时有效不填则查询所有防御模式的数据总和 DefenceMode 映射如下： observe = '观察模式' intercept = '拦截模式'

3. 输出参数

参数名称	类型	描述
TopTypeData	Array of ScdnTypeData	WAF 攻击类型统计注意：此字段可能返回 null，表示取不到有效值。
TopIpData	Array of ScdnTopData	TOP 攻击源 IP 统计注意：此字段可能返回 null，表示取不到有效值。
Mode	String	查询的SCDN类型，当前仅支持 waf
TopUrlData	Array of ScdnTopUrlData	TOP URL 统计注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取SCDN的Top数据

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeScdnTopData
&Domain=www.test.com
&Mode=waf
&Filter=request
&Metric=url
&StartTime=2019-06-2600:00:00
&EndTime=2019-06-2603:00:00
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4f1bb066-524f-4857-87f4-0ae56439179b",
        "TopTypeData": [
            {
                "AttackType": "xss",
                "Value": 20
            },
            {
                "AttackType": "sql",
                "Value": 831
            }
        ],
        "TopIpData": [
            {
                "Time": "2019-06-26 05:42:56",
                "Value": 18,
                "Isp": "中国电信",
                "Ip": "222.186.20.85"
            }
        ],
        "Mode": "waf"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.CdnDbError	内部数据错误，请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError	系统错误，请联系腾讯云工程师进一步排查。
InternalError.DataSystemError	数据查询错误，请联系腾讯云工程师进一步排查。
InvalidParameter.CDNStatusInvalidDomain	域名状态不合法。
InvalidParameter.CdnParamError	参数错误，请参考文档中示例参数填充。
InvalidParameter.CdnStatInvalidDate	日期不合法，请参考文档中日期示例。
InvalidParameter.CdnStatInvalidFilter	统计维度不合法，请参考文档中统计分析示例。
InvalidParameter.CdnStatInvalidMetric	统计类型不合法，请参考文档中统计分析示例。
ResourceNotFound.CdnHostNotExists	未查询到该域名，请确认域名是否正确。
ResourceNotFound.CdnUserNotExists	未开通CDN服务，请开通后使用此接口。
UnauthorizedOperation.CdnAccountUnauthorized	子账号禁止查询整体数据。
UnauthorizedOperation.CdnCamUnauthorized	子账号未配置cam策略。