API 文档

查询报表数据

最近更新时间:2021-03-02 08:04:04

我的收藏

1. 接口描述

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

DescribeReportData 用于查询域名/项目维度的日/周/月报表数据。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeReportData。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
StartTime Date 查询起始时间:yyyy-MM-dd
当报表类型为daily,起始时间和结束时间必须为同一天
当报表类型为weekly,起始时间须为周一,结束时间须为同一周的周日
当报表类型为monthly,起始时间须为自然月第一天,即1号,结束时间须为该自然月最后一天
EndTime Date 查询结束时间:yyyy-MM-dd
当报表类型为daily,起始时间和结束时间必须为同一天
当报表类型为weekly,起始时间须为周一,结束时间须为同一周的周日
当报表类型为monthly,起始时间须为自然月第一天,即1号,结束时间须为该自然月最后一天
ReportType String 报表类型
daily:日报表
weekly:周报表(周一至周日)
monthly:月报表(自然月)
Area String 域名加速区域
mainland:中国境内
overseas:中国境外
Offset Integer 偏移量,默认0。
Limit Integer 数据个数,默认1000。
Project Integer 按项目ID筛选

3. 输出参数

参数名称 类型 描述
DomainReport Array of ReportData 域名维度数据详情
ProjectReport Array of ReportData 项目维度数据详情
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询报表数据

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeReportData
&StartTime=2020-02-01
&EndTime=2020-02-29
&ReportType=monthly
&Area=mainland
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "8aa8eb8d-d704-45a9-ae81-9606243193cb",
    "DomainReport": [
      {
        "Resource": "www.test1.com",
        "ResourceId": "cdn-8km12345",
        "Value": 100,
        "Percentage": 50,
        "BillingValue": 100,
        "BillingPercentage": 50
      },
      {
        "Resource": "www.test2.com",
        "ResourceId": "cdn-rl523456",
        "Value": 100,
        "Percentage": 50,
        "BillingValue": 100,
        "BillingPercentage": 50
      }
    ],
    "ProjectReport": [
      {
        "Resource": "p1",
        "ResourceId": "123",
        "Value": 100,
        "Percentage": 10,
        "BillingValue": 100,
        "BillingPercentage": 10
      },
      {
        "Resource": "默认项目",
        "ResourceId": "0",
        "Value": 900,
        "Percentage": 90,
        "BillingValue": 900,
        "BillingPercentage": 90
      }
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误,请联系腾讯云工程师进一步排查。
InternalError.InvalidErrorCode 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。
UnsupportedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
目录