Help & DocumentationAPIsContent Delivery NetworkData Query APIsDescribeCdnData

DescribeCdnData

Last updated: 2020-02-10 16:53:09

1. API Description

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

This API (DescribeCdnData) is used to query CDN real-time access monitoring data and supports the following metrics:

Traffic (in bytes)
Bandwidth (in bps)
Number of requests
Traffic hit rate (in % with two decimal digits)
Aggregate list of 2xx status codes and the details of status codes starting with 2 (in entries)
Aggregate list of 3xx status codes and the details of status codes starting with 3 (in entries)
Aggregate list of 4xx status codes and the details of status codes starting with 4 (in entries)
Aggregate list of 5xx status codes and the details of status codes starting with 5 (in entries)

A maximum of 20 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: DescribeCdnData
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	Timestamp	Queries start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.
EndTime	Yes	Timestamp	Queries end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days.
Metric	Yes	String	Specifies the query metric, which can be: flux: traffic (in bytes) bandwidth: bandwidth (in bps) request: number of requests fluxHitRate: traffic hit rate (in %) statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.
Domains.N	No	Array of String	Specifies the list of domain names to be queried Up to 30 domain names can be queried at a time
Project	No	Integer	Specifies the project ID to be queried, which can be viewed here Please note that if domain names are specified, this parameter will be ignored.
Interval	No	String	Time granularity; valid values: `min`: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China; `5min`: data with 5-minute granularity is returned when the queried period is no longer than 31 days; `hour`: data with 1-hour granularity is returned when the queried period is no longer than 31 days; `day`: data with 1-day granularity is returned when the queried period is longer than 31 days.
Detail	No	Boolean	The aggregate data for multiple domain names is returned by default (false) during a multi-domain-name query. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)
Isp	No	Integer	Specifies an ISP when you query the CDN data within Mainland China. If it is left blank, all ISPs will be queried. To view ISP codes, see ISP Code Mappings If you have specified an ISP, you cannot specify a province or an IP protocol for the same query.
District	No	Integer	Specifies a province when you query the CDN data within Mainland China. If it is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside Mainland China. If it is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see Province Code Mappings If you have specified a province for your query on CDN data within mainland China, you cannot specify an ISP or an IP protocol for the same query.
Protocol	No	String	Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. all: All protocols http: specifies the HTTP metric to be queried https: specifies the HTTPS metric to be queried
DataSource	No	String	Specifies the data source to be queried, which can be seen as the whitelist function.
IpProtocol	No	String	Specifies an IP protocol; if it is left blank, all IP protocols will be queried. `all`: All protocols `ipv4`: IPv4 `ipv6`: IPv6 If the IP protocol to be queried is specified, the district and ISP cannot be specified at the same time
Area	No	String	Specifies a service region. If this value is left blank, CDN data within Mainland China will be queried. `mainland`: specifies to query CDN data within Mainland China; `overseas`: specifies to query CDN data outside Mainland China.
AreaType	No	String	Specifies a region type for your query on CDN data outside Mainland China. If this parameter is left blank, data on the service region will be queried. This parameter is valid only when `Area` is `overseas`. `server`: specifies to query data on the service region where Tencent Cloud CDN nodes are located; `client`: specifies to query data on the client region where the request devices are located.

3. Output Parameters

Parameter Name	Type	Description
Interval	String	Time granularity of the returned data. Specify one of the following during querying: min: 1 minute 5min: 5 minutes hour: 1 hour day: 1 day
Data	Array of ResourceData	Returned data details of the specified conditional query
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeCdnData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=flux
&Domains.0=www.test.com
&Project=0
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "123",
    "Data": [
      {
        "Resource": "www.test.com",
        "CdnData": [
          {
            "Metric": "flux",
            "DetailData": [
              {
                "Time": "2018-09-03 00:00:00",
                "Value": 10
              },
              {
                "Time": "2018-09-03 00:05:00",
                "Value": 20
              }
            ],
            "SummarizedData": {
              "Name": "sum",
              "Value": 30
            }
          }
        ]
      }
    ],
    "Interval": "5min"
  }
}

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.

API 3.0 Explorer

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.
InternalError.DataSystemError	Error with the data query. Please submit a ticket for troubleshooting.
InvalidParameter.CdnHostInvalidParam	Invalid domain name format. Please check and try again.
InvalidParameter.CdnInterfaceError	Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError	Parameter error. Please see the sample parameters in the documentation.
InvalidParameter.CdnStatInvalidDate	Invalid date. Please see the sample date in the documentation.
InvalidParameter.CdnStatInvalidMetric	Invalid statistical type. Please see the sample statistical analysis in the documentation.
InvalidParameter.CdnStatInvalidProjectId	Incorrect project ID. Please check and try again.
InvalidParameter.CdnStatTooManyDomains	The number of queried domain names reached the limit.
LimitExceeded.CdnHostOpTooOften	Domain name operations are too frequent.
ResourceNotFound.CdnHostNotExists	This domain name does not exist under the account. Please check and try again.
ResourceNotFound.CdnUserNotExists	The CDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.CdnAccountUnauthorized	The sub-account is unauthorized to query full data.
UnauthorizedOperation.CdnCamUnauthorized	No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnHostUnauthorized	The sub-account has no access to the CDN-accelerated domain name.
UnauthorizedOperation.CdnProjectUnauthorized	The sub-account has no access to the project.
UnauthorizedOperation.CdnTagUnauthorized	The sub-account has no access to the tag.
UnauthorizedOperation.CdnUserIsSuspended	The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.CdnUserNoWhitelist	You are not in the beta whitelist and thus have no permission to use this function.

Previous: UpdatePayType Next: DescribeIpVisit

Tencent Cloud Documentation