1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
DescribeTopData 通过入参 Metric 和 Filter 组合不同,可以查询以下排序数据:
- 依据总流量、总请求数对访问 IP 排序,从大至小返回 TOP 100 IP
- 依据总流量、总请求数对访问 Refer 排序,从大至小返回 TOP 100 Refer
- 依据总流量、总请求数对访问 设备 排序,从大至小返回 设备类型
- 依据总流量、总请求数对访问 操作系统 排序,从大至小返回 操作系统
- 依据总流量、总请求数对访问 浏览器 排序,从大至小返回 浏览器
注意:
- 仅支持 90 天内数据查询,且从2021年09月20日开始有数据
- 本接口为beta版,尚未正式全量发布
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTopData。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | String | 查询起始日期:yyyy-MM-dd HH:mm:ss 仅支持按天粒度的数据查询,取入参中的天信息作为起始日期 返回大于等于起始日期当天 00:00:00 点产生的数据,如 StartTime为2018-09-04 10:40:00,返回数据的起始时间为2018-09-04 00:00:00 仅支持 90 天内数据查询 示例值:2021-01-01 00:00:00 |
EndTime | 是 | String | 查询结束日期:yyyy-MM-dd HH:mm:ss 仅支持按天粒度的数据查询,取入参中的天信息作为结束日期 返回小于等于结束日期当天 23:59:59 产生的数据,如EndTime为2018-09-05 22:40:00,返回数据的结束时间为2018-09-05 23:59:59 EndTime 需要大于等于 StartTime 示例值:2021-01-01 23:59:59 |
Metric | 是 | String | 排序对象,支持以下几种形式: ip、ua_device、ua_browser、ua_os、referer 示例值:ip |
Filter | 是 | String | 排序使用的指标名称: flux:Metric 为 host 时指代访问流量 request:Metric 为 host 时指代访问请求数 示例值:flux |
Domains.N | 否 | Array of String | 指定查询域名列表,最多可一次性查询 30 个加速域名明细 示例值:www.test.com |
Project | 否 | Integer | 未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主 示例值:0 |
Detail | 否 | Boolean | 是否详细显示每个域名的的具体数值 示例值:false |
Area | 否 | String | 指定服务地域查询,不填充表示查询中国境内 CDN 数据 mainland:指定查询中国境内 CDN 数据 overseas:指定查询中国境外 CDN 数据 示例值:mainland |
Product | 否 | String | 指定查询的产品数据,目前仅可使用cdn 示例值:cdn |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of TopDataMore | 各个资源的Top 访问数据详情。 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设备数据返回
查询ua_device指标的数据
输入示例
https://cdn.tencentcloudapi.com/?Action=DescribeTopData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=ua_device
&Filter=request
&Domains.0=www.test.com
&Domains.1=www.test.com
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "37aabaa8-c4c1-45ea-a4aa-8bafea1a496d",
"Data": [
{
"Resource": "all",
"DetailData": [
{
"Name": "桌面",
"Value": 635,
"Percent": 0.6642
},
{
"Name": "其他/未知",
"Value": 260,
"Percent": 0.272
},
{
"Name": "移动",
"Value": 61,
"Percent": 0.0638
}
]
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CdnConfigError | 域名配置更新操作失败,请重试或联系客服人员解决。 |
InternalError.CamSystemError | 内部鉴权系统错误。 |
InternalError.CdnConfigError | 域名配置更新失败。 |
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnQueryParamError | 内部查询错误,请重试或联系客服人员解决。 |
InternalError.CdnQuerySystemError | 内部查询错误,请重试或联系客服人员解决。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.DataSystemError | 数据查询错误,请联系腾讯云工程师进一步排查。 |
InternalError.Error | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnHostInvalidParam | 域名格式不合法,请确认后重试。 |
InvalidParameter.CdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.CdnStatInvalidDate | 日期不合法,请参考文档中日期示例。 |
InvalidParameter.CdnStatInvalidFilter | 统计维度不合法,请参考文档中统计分析示例。 |
InvalidParameter.CdnStatInvalidMetric | 统计类型不合法,请参考文档中统计分析示例。 |
InvalidParameter.CdnStatInvalidProjectId | 项目ID错误,请确认后重试。 |
InvalidParameter.CdnStatTooManyDomains | 查询的域名数量超过限制。 |
LimitExceeded.CdnHostOpTooOften | 域名操作过于频繁。 |
ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 |
ResourceNotFound.CdnProjectNotExists | 项目不存在,请确认后重试。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
UnauthorizedOperation.CdnAccountUnauthorized | 子账号禁止查询整体数据。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnHostUnauthorized | CDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnProjectUnauthorized | 子账号项目未授权。 |
UnauthorizedOperation.CdnUserIsSuspended | 加速服务已停服,请重启加速服务后重试。 |
UnauthorizedOperation.CdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |