API

History
Introduction
API Category
Making API Requests
- Request Structure
- Common Params
- Signature v3
- Signature
- Responses
Site APIs
- CreateZone
- DescribeIdentifications
- ModifyZone
- DeleteZone
- ModifyZoneStatus
- CheckCnameStatus
- IdentifyZone
- DescribeZones
- VerifyOwnership
Acceleration Domain Management APIs
- CreateAccelerationDomain
- DescribeAccelerationDomains
- ModifyAccelerationDomain
- ModifyAccelerationDomainStatuses
- DeleteAccelerationDomains
- CreateSharedCNAME
- BindSharedCNAME
- DeleteSharedCNAME
Site Acceleration Configuration APIs
- CreateRule
- DeleteRules
- DescribeHostsSetting
- DescribeRules
- DescribeRulesSetting
- DescribeZoneSetting
- ModifyRule
- ModifyZoneSetting
Alias Domain APIs
- CreateAliasDomain
- DescribeAliasDomains
- ModifyAliasDomain
- ModifyAliasDomainStatus
- DeleteAliasDomain
Security Configuration APIs
- CreateSecurityIPGroup
- DescribeSecurityIPGroup
- ModifySecurityIPGroup
- DeleteSecurityIPGroup
- DescribeOriginProtection
- DescribeSecurityTemplateBindings
- ModifySecurityPolicy
- BindSecurityTemplateToEntity
- DescribeSecurityIPGroupInfo
Layer 4 Application Proxy APIs
- CreateL4Proxy
- ModifyL4Proxy
- ModifyL4ProxyStatus
- DescribeL4Proxy
- DeleteL4Proxy
- CreateL4ProxyRules
- ModifyL4ProxyRules
- ModifyL4ProxyRulesStatus
- DescribeL4ProxyRules
- DeleteL4ProxyRules
- CreateApplicationProxy
- ModifyApplicationProxy
- ModifyApplicationProxyStatus
- DescribeApplicationProxies
- DeleteApplicationProxy
- CreateApplicationProxyRule
- ModifyApplicationProxyRule
- ModifyApplicationProxyRuleStatus
- DeleteApplicationProxyRule
Content Management APIs
- CreatePurgeTask
- DescribePurgeTasks
- CreatePrefetchTask
- DescribePrefetchTasks
- DescribeContentQuota
Data Analysis APIs
- DescribeDDoSAttackData
- DescribeDDoSAttackEvent
- DescribeDDoSAttackTopData
- DescribeOverviewL7Data
- DescribeTimingL4Data
- DescribeTimingL7AnalysisData
- DescribeTopL7AnalysisData
- DescribeTimingL7CacheData
- DescribeTopL7CacheData
Log Service APIs
- DownloadL7Logs
- DownloadL4Logs
- CreateCLSIndex
- CreateRealtimeLogDeliveryTask
- ModifyRealtimeLogDeliveryTask
- DeleteRealtimeLogDeliveryTask
- DescribeRealtimeLogDeliveryTasks
Billing APIs
- CreatePlan
- UpgradePlan
- RenewPlan
- ModifyPlan
- IncreasePlanQuota
- DestroyPlan
- CreatePlanForZone
- BindZoneToPlan
- DescribeBillingData
- DescribeAvailablePlans
Certificate APIs
- DescribeDefaultCertificates
- ModifyHostsCertificate
Load Balancing APIs
- CreateOriginGroup
- ModifyOriginGroup
- DeleteOriginGroup
- DescribeOriginGroup
Custom Response Page APIs
- CreateCustomizeErrorPage
- DescribeCustomErrorPages
- ModifyCustomErrorPage
- DeleteCustomErrorPage
Diagnostic Tool APIs
- DescribeIPRegion
Version Management APIs
- CreateConfigGroupVersion
- DeployConfigGroupVersion
- DescribeConfigGroupVersionDetail
- DescribeConfigGroupVersions
- DescribeDeployHistory
- DescribeEnvironments
Data Types
Error Codes

DescribeTopL7AnalysisData

1. API Description

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

This API is used to query the top N data of the L7 domain name by a specified dimension. Note that there is a delay of about 10 minutes for this API. It is recommended to pull data from 10 minutes before the current time.

A maximum of 100 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: DescribeTopL7AnalysisData.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
StartTime	Yes	Timestamp ISO8601	The start time.
EndTime	Yes	Timestamp ISO8601	The end time.
MetricName	Yes	String	The metrics queried. Valid values: l7Flow_outFlux_country: statistics of the L7 EdgeOne response traffic by country/region; l7Flow_outFlux_province: statistics of the L7 EdgeOne response traffic by province within the Chinese mainland; l7Flow_outFlux_statusCode: statistics of the L7 EdgeOne response traffic by status code; l7Flow_outFlux_domain: statistics of the L7 EdgeOne response traffic by domain name; l7Flow_outFlux_url: statistics of the L7 EdgeOne response traffic by URL path; l7Flow_outFlux_resourceType: statistics of the L7 EdgeOne response traffic by resource type; l7Flow_outFlux_sip: statistics of the L7 EdgeOne response traffic by client IP; l7Flow_outFlux_referers: statistics of the L7 EdgeOne response traffic by Referer; l7Flow_outFlux_ua_device: statistics of the L7 EdgeOne response traffic by device type; l7Flow_outFlux_ua_browser: statistics of the L7 EdgeOne response traffic by browser type; l7Flow_outFlux_us_os: statistics of the L7 EdgeOne response traffic by operating system type; l7Flow_request_country: statistics of the L7 access request count by country/region; l7Flow_request_province: statistics of the L7 access request count by province within the Chinese mainland; l7Flow_request_statusCode: statistics of the L7 access request count by status code; l7Flow_request_domain: statistics of the L7 access request count by domain name; l7Flow_request_url: statistics of the L7 access request count by URL path; l7Flow_request_resourceType: statistics of the L7 access request count by resource type; l7Flow_request_sip: statistics of the L7 access request count by client IP; l7Flow_request_referer: statistics of the L7 access request count by Referer; l7Flow_request_ua_device: statistics of the L7 access request count by device type; l7Flow_request_ua_browser: statistics of the L7 access request count by browser type; l7Flow_request_us_os: statistics of the L7 access request count by operating system type.
ZoneIds.N	No	Array of String	ZoneId set. This parameter is required.
Limit	No	Integer	Indicates the top N data to be queried. The maximum value is 1000. If this parameter is not input, the default value is 10, indicating querying the top 10 data.
Filters.N	No	Array of QueryCondition	Filter criteria. The detailed Key values are as follows: country: Filter by country/region. The country/region follows the ISO 3166-1 alpha-2 standard. Example value: CN. province: Filter by province. This parameter is supported only when the service area is the Chinese mainland. For province codes, refer to the Mapping Table of Provinces Within the Chinese Mainland. Example value: 22. isp: Filter by ISP. This parameter is supported only when the service area is the Chinese mainland. Valid values are as follows: 2: China Telecom; 26: China Unicom; 1046: China Mobile; 3947: China Tietong; 38: CERNET; 43: Great Wall Broadband; 0: other ISPs. domain: Filter by subdomain name. Example value: www.example.com. url: Filter by URL path. Example value: /content or /content/test.jpg. If the url parameter is input, up to 30 days of data can be queried. referer: Filter by Referer request header. Example value: http://www.example.com/. If the referer parameter is input, up to 30 days of data can be queried. resourceType: Filter by resource type, which is generally the file suffix. Example value: .jpg. If the resourceType parameter is input, up to 30 days of data can be queried; protocol: Filter by HTTP protocol version. Valid values are as follows: HTTP/1.0; HTTP/1.1; HTTP/2.0; HTTP/3; WebSocket. socket: Filter by HTTP protocol type. Valid values are as follows: HTTP: HTTP protocol; HTTPS: HTTPS protocol; QUIC: QUIC protocol. statusCode: Filter by edge status code. If the statusCode parameter is input, up to 30 days of data can be queried. Valid values are as follows: 1XX: 1xx status code; 2XX: 2xx status code; 3XX: 3xx status code; 4XX: 4xx status code; 5XX: 5xx status code; An integer within the range [0,600). browserType: Filter by browser type. If the browserType parameter is input, up to 30 days of data can be queried. Valid values are as follows: Firefox: Firefox browser; Chrome: Chrome browser; Safari: Safari browser; Other: other browser types; Empty: The browser type is empty; Bot: search engine crawler; MicrosoftEdge: Microsoft Edge browser; IE: IE browser; Opera: Opera browser; QQBrowser: QQ browser; LBBrowser: LB browser; MaxthonBrowser: Maxthon browser; SouGouBrowser: Sogou browser; BIDUBrowser: Baidu browser; TaoBrowser: Tao browser; UBrowser: UC browser. deviceType: Filter by device type. If the deviceType parameter is input, up to 30 days of data can be queried. Valid values are as follows: TV: TV device; Tablet: tablet device; Mobile: mobile device; Desktop: desktop device; Other: other device types; Empty: The device type is empty. operatingSystemType: Filter by operating system type. If the operatingSystemType parameter is input, up to 30 days of data can be queried. Valid values are as follows: Linux: Linux operating system; MacOS: MacOS operating system; Android: Android operating system; IOS: iOS operating system; Windows: Windows operating system; NetBSD: NetBSD; ChromiumOS: ChromiumOS; Bot: search engine crawler; Other: other types of operating systems; Empty: The operating system is empty. tlsVersion: Filter by TLS version. If the tlsVersion parameter is input, up to 30 days of data can be queried. Valid values are as follows: TLS1.0; TLS1.1; TLS1.2; TLS1.3. ipVersion: Filter by IP version. Valid values are as follows: 4: IPv4; 6: IPv6. cacheType: Filter by cache status. Valid values are as follows: hit: The request hits the EdgeOne node cache and the resources are provided by the node cache. A partial cache hit for resources is also recorded as hit. miss: The request does not hit the EdgeOne node cache and the resources are provided by the origin server. dynamic: The requested resources cannot be cached or are not configured with node cache and are provided by the origin server. other: unrecognizable cache status. Requests responded to by edge functions are recorded as other. clientIp: Filter by client IP.
Interval	No	String	Query period granularity. Valid values: min: 1 minute; 5min: 5 minutes; hour: 1 hour; day: 1 day. If this parameter is not filled in, the granularity will be automatically calculated based on the interval between the start time and end time. Specifically, data will be queried with a granularity of min, 5min, hour, and day respectively when the period is no more than 2 hours, no more than 2 days, no more than 7 days, and over 7 days.
Area	No	String	Data region. Values: overseas: Regions outside the Chinese mainland mainland: Chinese mainland global: Global If this field is not specified, the default value `global` is used.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of query results.
Data	Array of TopDataRecord	The top N data list obtained from the statistics of L7 access data by a specified dimension MetricName. Note: This field may return null, which indicates a failure to obtain a valid value.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Traffic Data of the Top URL Path Under a Specific HTTP Protocol Version

This example shows you how to query the traffic data of the top URL path under a specific HTTP protocol version (HTTP/1.0 or HTTP/1.1).

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7AnalysisData
<Common request parameters>

{
    "Area": "mainland",
    "Interval": "day",
    "Limit": "1",
    "StartTime": "2022-07-31T00:00:00+08:00",
    "EndTime": "2022-08-29T19:17:59+08:00",
    "MetricName": "l7Flow_outFlux_url",
    "Filters": [
        {
            "Key": "protocol",
            "Operator": "equals",
            "Value": [
                "HTTP/1.0",
                "HTTP/1.1"
            ]
        }
    ],
    "ZoneIds": [
        "zone-2mzegj4vln5f"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "7c499897-8ad9-4a2d-884e-6154f283d723",
        "Data": [
            {
                "DetailData": [
                    {
                        "Key": "/",
                        "Value": 1210001
                    }
                ],
                "TypeKey": "251227260"
            }
        ],
        "TotalCount": 1
    }
}

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
FailedOperation	Operation failed.
InternalError.ProxyServer	An unknown error occurred in the backend server.
InvalidParameter	Parameter error.
InvalidParameterValue	Invalid parameter value.
LimitExceeded	The quota limit has been reached.
LimitExceeded.QueryTimeLimitExceeded	Query time limit exceeded.
OperationDenied	Operation denied.
ResourceNotFound	The resource doesn’t exist.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Querying the Traffic Data of the Top URL Path Under a Specific HTTP Protocol Version
5. Developer Resources
SDK
Command Line Interface
6. Error Code