1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
ListTopData 通过入参 Metric 和 Filter 组合不同,可以查询以下排序数据:
- 依据总流量、总请求数对访问 URL 排序,从大至小返回 TOP 1000 URL
- 依据总流量、总请求数对客户端省份排序,从大至小返回省份列表
- 依据总流量、总请求数对客户端运营商排序,从大至小返回运营商列表
- 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序,从大至小返回域名列表
- 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序,从大至小返回域名列表
注意:仅支持 90 天内数据查询
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListTopData。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | Timestamp | 查询起始时间:yyyy-MM-dd HH:mm:ss 仅支持按分钟粒度的数据查询,按入参抹去秒位作为起始时间,如 StartTime为2018-09-04 10:40:23,返回数据的起始时间为2018-09-04 10:40:00 仅支持 90 天内数据查询 示例值:2021-01-01 00:00:00 |
EndTime | 是 | Timestamp | 查询结束时间: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 | 排序对象,支持以下几种形式: url:访问 URL 排序(无参数的URL),支持的 Filter 为 flux、request district:省份、国家/地区排序,支持的 Filter 为 flux、request isp:运营商排序,支持的 Filter 为 flux、request host:域名访问数据排序,支持的 Filter 为:flux、request、bandwidth、fluxHitRate、2XX、3XX、4XX、5XX、statusCode originHost:域名回源数据排序,支持的 Filter 为 flux、request、bandwidth、origin_2XX、origin_3XX、origin_4XX、origin_5XX、OriginStatusCode 示例值:host |
Filter | 是 | String | 排序使用的指标名称: flux:Metric 为 host 时指代访问流量,originHost 时指代回源流量 bandwidth:Metric 为 host 时指代访问带宽,originHost 时指代回源带宽 request:Metric 为 host 时指代访问请求数,originHost 时指代回源请求数 fluxHitRate:平均流量命中率 2XX:访问 2XX 状态码 3XX:访问 3XX 状态码 4XX:访问 4XX 状态码 5XX:访问 5XX 状态码 origin_2XX:回源 2XX 状态码 origin_3XX:回源 3XX 状态码 origin_4XX:回源 4XX 状态码 origin_5XX:回源 5XX 状态码 statusCode:指定访问状态码统计,在 Code 参数中填充指定状态码 OriginStatusCode:指定回源状态码统计,在 Code 参数中填充指定状态码 示例值:flux |
Domains.N | 否 | Array of String | 指定查询域名列表,最多可一次性查询 30 个加速域名明细 示例值:www.test.com |
Project | 否 | Integer | 指定要查询的项目 ID,前往查看项目 ID 未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主 示例值:0 |
Detail | 否 | Boolean | 多域名查询时,默认(false)返回所有域名汇总排序结果 Metric 为 url、path、district、isp,Filter 为 flux、request 时,可设置为 true,返回每一个 Domain 的排序数据 示例值:false |
Code | 否 | String | Filter 为 statusCode、OriginStatusCode 时,填充指定状态码查询排序结果 示例值:200 |
Area | 否 | String | 指定服务地域查询,不填充表示查询中国境内 CDN 数据 mainland:指定查询中国境内 CDN 数据 overseas:指定查询中国境外 CDN 数据,支持的 Metric 为 url、district、host、originHost,当 Metric 为 originHost 时仅支持 flux、request、bandwidth Filter 示例值:overseas |
AreaType | 否 | String | 查询中国境外CDN数据,且仅当 Metric 为 district 或 host 时,可指定地区类型查询,不填充表示查询服务地区数据(仅在 Area 为 overseas,且 Metric 是 district 或 host 时可用) server:指定查询服务地区(腾讯云 CDN 节点服务器所在地区)数据 client:指定查询客户端地区(用户请求终端所在地区)数据,当 Metric 为 host 时仅支持 flux、request、bandwidth Filter 示例值:server |
Product | 否 | String | 指定查询的产品数据,可选为cdn或者ecdn,默认为cdn 示例值:cdn |
Limit | 否 | Integer | 只返回前N条数据,默认为最大值100,metric=url时默认为最大值1000 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of TopData | 各个资源的Top 访问数据详情。 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Top Url访问数据
输入示例
https://cdn.tencentcloudapi.com/?Action=ListTopData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=Url
&Filter=flux
&Domains.0=www.test.com
&Domains.1=www.test.com
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "123",
"Data": [
{
"Resource": "www.test1.com",
"DetailData": [
{
"Name": "www.test1.com/1.jpg?abc=123",
"Value": 13838
}
]
},
{
"Resource": "www.test2.com",
"DetailData": [
{
"Name": "http://www.test2.com/1.jpg?abc=123",
"Value": 2501
}
]
}
]
}
}
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.CdnQuerySystemError | 内部查询错误,请重试或联系客服人员解决。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InternalError.DataSystemError | 数据查询错误,请联系腾讯云工程师进一步排查。 |
InternalError.Error | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.RouteError | 内部服务错误,请联系腾讯云工程师进一步排查。 |
InternalError.TagSystemError | 标签内部错误,请重试或联系客服人员解决。 |
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 | 操作超出调用频次限制。 |