Help & DocumentationContent Delivery NetworkAPI Documentation Data Query APIsDescribeReportData

DescribeReportData

Last updated: 2020-05-09 10:29:35

PDF

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API is used to query the daily/weekly/monthly report data at domain name/project levels.

A maximum of 10 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeReportData.
Version Yes String Common parameter. The value used for this API: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
StartTime Yes Date Query start time
EndTime Yes Date Query end time
ReportType Yes String Report type
daily: daily report
weekly: weekly report
monthly: monthly report
Area Yes String Domain name acceleration region
mainland: in Mainland China
overseas: outside Mainland China
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of data entries. Default value: 1000.
Project No Integer Filters by project ID

3. Output Parameters

Parameter Name Type Description
DomainReport Array of ReportData Domain name-level data details.
ProjectReport Array of ReportData Project-level data details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying report data

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeReportData
&StartTime=2020-02-01
&EndTime=2020-02-29
&ReportType=monthly
&Area=mainland
&<Common request parameters>

Output Example

{
  "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": "Default Project",
        "ResourceId": "0",
        "Value": 900,
        "Percentage": 90,
        "BillingValue": 900,
        "BillingPercentage": 90
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.