Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

DescribeCdnData

Last updated: 2023-12-01 16:39:47

1. API Description

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

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

Traffic (in bytes)
Bandwidth (in bps)
Number of requests
Number of hit requests
Request hit rate (in %)
Hit traffic (in bytes)
Traffic hit rate (in %)
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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeCdnData.
Version	Yes	String	Common Params. The value used for this API: 2018-06-06.
Region	No	String	Common Params. This parameter is not required for this API.
StartTime	Yes	Timestamp	Start time of the query, e.g., 2018-09-04 10:40:00. The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.
EndTime	Yes	Timestamp	End time of the query, e.g. 2018-09-04 10:40:00. The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.
Metric	Yes	String	Specifies the metric to query, which can be: `flux`: Traffic (in bytes) `fluxIn`: Upstream traffic (in bytes), only used for the `ecdn` product `fluxOut`: Downstream traffic (in bytes), only used for the `ecdn` product `bandwidth`: Bandwidth (in bps) `bandwidthIn`: Upstream bandwidth (in bps), only used for the `ecdn` product `bandwidthOut`: Downstream bandwidth (in bps), only used for the `ecdn` product `request`: Number of requests `hitRequest`: Number of hit requests `requestHitRate`: Request hit rate (in % with two decimal digits) `hitFlux`: Hit traffic (in bytes) `fluxHitRate`: Traffic hit rate (in % with two decimal digits) `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) Specifies the status code to 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 You can specify one or more domain names. Up to 30 domain names can be queried in one request. If this parameter is not specified, it means to query all domain names under the current account.
Project	No	Integer	Specifies the project ID to be queried. Check project ID in the console Note that `Project` will be ignored if `Domains` is specified.
Interval	No	String	Sampling interval. The available options vary for different query period. See below: `min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`. `5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days. `hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days. `day`: Return data with 1-day granularity. It’s available when the query 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 the Chinese mainland. If this is left blank, all ISPs will be queried. To view ISP codes, see ISP Code Mappings Note that only one of `District`, `Isp` and `IpProtocol` can be specified.
District	No	Integer	Specifies a province when you query the CDN data within the Chinese mainland. If this is left blank, all provinces will be queried. Specifies a country/region when you query the CDN data outside the Chinese mainland. If this is left blank, all countries/regions will be queried. To view codes of provinces or countries/regions, see Province Code Mappings. When `Area` is `mainland`, you can query by the province. Note that only one of `District`, `Isp` and `IpProtocol` can be specified.
Protocol	No	String	Specifies the protocol to be queried; if you leave it blank, all protocols will be queried. `all`: All protocols `http`: Query HTTP data `https`: Query HTTPS data
DataSource	No	String	Specifies the data source to be queried. It’s only open to beta users now.
IpProtocol	No	String	Specifies the IP protocol to be queried. If it’s not specified, data of all IP protocols are returned. `all`: All protocols `ipv4`: Query IPv4 data `ipv6`: Query IPv6 data If `IpProtocol` is specified, `District` parameter can not be specified at the same time. Note: `ipv4` and `ipv6` are only available to beta users.
Area	No	String	Specifies the service area. If it’s not specified, CDN data of the Chinese mainland are returned. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland.
AreaType	No	String	Specify whether to query by the region of the server or client. This parameter is valid only when `Area` is `overseas`. `server`: Query by the location of server (Tencent Cloud CDN nodes) `client`: Query by the location of the client (where the request devices are located)
Product	No	String	Specifies the product to query, either `cdn` (default) or `ecdn`.
TimeZone	No	String	Specifies a time zone to query. The default time zone is UTC+08:00.

3. Output Parameters

Parameter Name	Type	Description
Interval	String	Time granularity of the returned data. `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

Example1 Querying CDN access data

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

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
AuthFailure.InvalidAuthorization	Authentication error. Please check and try again.
FailedOperation.CdnConfigError	Failed to update the domain name configuration. Please submit a ticket for troubleshooting.
InternalError.CamSystemError	Authentication system internal error.
InternalError.CdnConfigError	Failed to update the domain name configuration.
InternalError.CdnDbError	Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnQuerySystemError	Internal error. Please try again or contact the customer service for assistance.
InternalError.CdnSystemError	System error. Please submit a ticket for troubleshooting.
InternalError.CostDataSystemError	Billing data query internal error. Please submit a ticket for troubleshooting.
InternalError.DataSystemError	Error with the data query. Please submit a ticket for troubleshooting.
InternalError.Error	Service internal error. Please submit a ticket for troubleshooting.
InternalError.InvalidErrorCode	Service internal error. Please submit a ticket for troubleshooting.
InternalError.ProxyServer	Internal service error. Please submit a ticket for troubleshooting.
InternalError.RouteError	Internal service error. Please submit a ticket for troubleshooting.
InternalError.TagSystemError	Tag internal error. 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.CdnInvalidParamMetric	Parameter error: Metric. Please check and try again.
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	Unable to find the domain name. Please make sure the domain name is correct.
ResourceNotFound.CdnProjectNotExists	The project does not exist. 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 project is not authorized for the sub-account.
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.
UnauthorizedOperation.CsrfError	Service internal error. Please submit a ticket for troubleshooting.
UnauthorizedOperation.OpNoAuth	This operation is not supported currently. Please submit a ticket for assistance.
UnauthorizedOperation.OperationTooOften	Too many calling attempts.

tencent cloud

Recent Pages

DescribeCdnData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying CDN access data

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeCdnData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying CDN access data

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?