TOP 数据查询

最近更新时间:2019-06-14 17:17:21

1. 接口描述

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

ListTopData 通过入参 Metric 和 Filter 组合不同,可以查询以下排序数据:

  • 依据总流量、总请求数对访问 URL 排序,从大至小返回 TOP 1000 URL
  • 依据总流量、总请求数对客户端省份排序,从大至小返回省份列表
  • 依据总流量、总请求数对客户端运营商排序,从大至小返回运营商列表
  • 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序,从大至小返回域名列表
  • 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序,从大至小返回域名列表

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListTopData
Version String 公共参数,本接口取值:2018-06-06
Region String 公共参数,本接口不需要传递此参数。
StartTime Timestamp 查询起始日期,如:2018-09-09 00:00:00
EndTime Timestamp 查询结束日期,如:2018-09-10 00:00:00
Metric String 排序对象,支持以下几种形式:
Url:访问 URL 排序,带参数统计,支持的 Filter 为 flux、request
Path:访问 URL 排序,不带参数统计,支持的 Filter 为 flux、request(白名单功能)
District:省份排序,支持的 Filter 为 flux、request
Isp:运营商排序,支持的 Filter 为 flux、request
Host:域名访问数据排序,支持的 Filter 为:flux, request, bandwidth, fluxHitRate, 2XX, 3XX, 4XX, 5XX,具体状态码统计
originHost:域名回源数据排序,支持的 Filter 为 flux, request,bandwidth,origin_2XX,origin_3XX,oringin_4XX,origin_5XX,具体回源状态码统计
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 参数中填充指定状态码
Domains.N Array of String 指定查询域名列表,最多可一次性查询 30 个加速域名明细
Project Integer 指定要查询的项目 ID,前往查看项目 ID
未填充域名情况下,指定项目查询,若填充了具体域名信息,以域名为主
Detail Boolean 多域名查询时,默认(false)返回所有域名汇总排序结果
Metric 为 Url、Path、District、Isp,Filter 为 flux、reqeust 时,可设置为 true,返回每一个 Domain 的排序数据
Code String Filter 为 statusCode、OriginStatusCode 时,填充指定状态码查询排序结果

3. 输出参数

参数名称 类型 描述
Data Array of TopData 各个资源的Top 访问数据详情。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnHostInvalidParam 域名格式不合法,请确认后重试
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例
InvalidParameter.CdnStatInvalidFilter 统计维度不合法,请参考文档中统计分析示例。
InvalidParameter.CdnStatInvalidMetric 统计类型不合法,请参考文档中统计分析示例
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试
InvalidParameter.CdnStatTooManyDomains 查询的域名数量超过限制。
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口
UnauthorizedOperation.CdnAccountUnauthorized 子账号禁止查询整体数据。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限