ListTopData

Last updated: 2020-03-16 17:17:53

PDF

1. API Description

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

This API is used to list data sorted the following ways by using different combinations of the Metric and Filter input parameters:

  • It sorts access URLs by total traffic and total requests, and returns the top 1,000 URLs in descending order.
  • It sorts client districts by total traffic and total requests, and returns the list of districts in descending order.
  • It sorts client ISPs by total traffic and total requests, and returns the list of ISPs in descending order.
  • It sorts domain names by total traffic, peak bandwidth, total requests, average hit rate, and 2XX/3XX/4XX/5XX status codes, and returns the list of domain names in descending order.
  • It sorts domain names by total origin-pull traffic, peak origin-pull bandwidth, total origin-pull requests, average origin-pull failure rate, and 2XX/3XX/4XX/5XX origin-pull status codes, and returns the list of domain names in descending order.

Note: only data from the last 90 days will be queried.

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: ListTopData.
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 Query start date. Example: 2018-09-09.
Only supports data query at daily granularity. The date in the input parameter is used as the start date.
Data generated at or after 00:00:00 on the start date will be returned.
Only data from the last 90 days will be queried.
EndTime Yes Timestamp Query end date. Example: 2018-09-10
Only supports data query at daily granularity. The date in the input parameter is used as the end date.
Data generated before or at 23:59:59 on the end date will be returned.
EndTime must be greater than or equal to StartTime
Metric Yes String Objects to be sorted. Valid values:
url: sorts access URLs with query string parameters included. Supported filters are flux and request.
path: sorts access URLs with query string parameters excluded. Supported filters are flux and request. You need to be whitelisted before using this feature.
district: sorts provinces or countries/regions. Supported filters are flux and request.
isp: sorts ISPs. Supported filters are flux and request.
host: sorts domain name access data. Supported filters are flux, request, bandwidth, fluxHitRate, 2XX, 3XX, 4XX, 5XX and statusCode.
originHost: sorts by domain name origin-pull data. Supported filters are flux, request, bandwidth, origin_2XX, origin_3XX, oringin_4XX, origin_5XX and OriginStatusCode
Filter Yes String Metric name used for sorting:
flux: If Metric is host, it indicates the access traffic; if Metric is originHost, it indicates the origin-pull traffic.
bandwidth: If Metric is host, it indicates the access bandwidth; if Metric is originHost, it indicates the origin-pull bandwidth.
request: If Metric is host, it indicates the number of access requests; if Metric is originHost, it indicates the number of origin-pull requests.
fluxHitRate: Average traffic hit rate
2XX: access 2XX status code
3XX: access 3XX status code
4XX: access 4XX status code
5XX: access 5XX status code
origin_2XX: origin-pull 2XX status code
origin_3XX: origin-pull 3XX status code
origin_4XX: origin-pull 4XX status code
origin_5XX: origin-pull 5XX status code
statusCode: statistics of a specific access status code which is specified in the Code parameter.
OriginStatusCode: statistics of a specific origin-pull status code which is specified in the Code parameter.
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.
Detail No Boolean Default value: false, indicating that results for all domain names are returned together when you query multiple domain names.
If Metric is Url, Path, District, or Isp and Filter is flux or request, you can set this parameter to true, indicating that results for each domain name are returned.
Code No String When Filter is statusCode or OriginStatusCode, enter a code to query and sort results.
Area No String Specifies a service region for the query. If it 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. Supported metrics are url, district, host, and originHost. If Metric is originHost, supported filters are flux, request, and bandwidth.
AreaType No String Specifies a region type for the query. If it is left blank, data on the service region will be queried. This parameter is only valid when Area is overseas and Metric is District or Host.
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; if Metric is Host, supported filters are flux, request, and bandwidth.

3. Output Parameters

Parameter Name Type Description
Data Array of TopData Top access data details of each resource
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. 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

5. 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.CdnStatInvalidFilter Invalid statistical dimension. Please see the sample statistical analysis 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.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.