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
边缘函数API
- 创建函数
- 描述函数
- 修改函数
- 创建函数规则
- 删除函数
- 描述函数规则
- 修改函数规则
- 修改函数规则优先级
- 删除函数规则
- 描述函数运行时环境
- 处理函数运行时环境
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
DNS记录API
- 创建DNS记录
- 删除DNS记录
- 描述DNS记录
- 修改DNS记录状态
- 修改DNS记录
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.intl.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	Queried metric. Valid values: l7Flow_outFlux_country: L7 EdgeOne response traffic aggregated by the country/region dimension; l7Flow_outFlux_province: L7 EdgeOne response traffic aggregated by the dimension of provinces in chinese mainland; l7Flow_outFlux_statusCode: L7 EdgeOne response traffic aggregated by the status code dimension; l7Flow_outFlux_domain: L7 EdgeOne response traffic aggregated by the domain name dimension; l7Flow_outFlux_url: L7 EdgeOne response traffic aggregated by url path dimension. l7Flow_outFlux_resourceType: L7 EdgeOne response traffic aggregated by the resource type dimension; l7Flow_outFlux_sip: L7 EdgeOne response traffic aggregated by the client IP dimension; l7Flow_outFlux_referers: L7 EdgeOne response traffic aggregated by referer dimension. l7Flow_outFlux_ua_device: L7 EdgeOne response traffic aggregated by the device type dimension; l7Flow_outFlux_ua_browser: L7 EdgeOne response traffic aggregated by the browser type dimension; l7Flow_outFlux_ua_os: L7 EdgeOne response traffic aggregated by the operating system type dimension; l7Flow_outFlux_ua: L7 EdgeOne response traffic aggregated by the User-Agent dimension; l7Flow_request_country: L7 request count aggregated by the country/region dimension; l7Flow_request_province: L7 request count aggregated by the dimension of provinces in the chinese mainland; l7Flow_request_statusCode: L7 request count aggregated by the status code dimension; l7Flow_request_domain: L7 request count aggregated by the domain name dimension; l7Flow_request_url: L7 request count aggregated by url Path dimension. l7Flow_request_resourceType: L7 request count aggregated by resource type dimension; l7Flow_request_sip: L7 request count aggregated by the client IP dimension; l7Flow_request_referer: L7 request count aggregated by referer dimension. l7Flow_request_ua_device: L7 request count aggregated by the device type dimension; l7Flow_request_ua_browser: L7 request count aggregated by the browser type dimension; l7Flow_request_ua_os: L7 request count aggregated by the operating system type dimension. l7Flow_request_ua: L7 request count aggregated by the User-Agent dimension.
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 of filter criteria 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. refer to the mapping table of provinces within the chinese mainland for province codes. Example value: 22. isp: filter by isp. This parameter only supports the service area of chinese mainland. The corresponding value options are as follows: 2: china telecom; 26: china unicom; 1046: cmcc; 3947: china tietong; 38: china education network; 43: great wall broadband; 0: other isp. domain: filter by subdomain. Example value: www.example.com. url: filter by url Path. Example value: /content or /content/test.jpg. If you fill in url parameters, you can query the data of the last 30 days at most. referer: filter by referer request header. Example value: http://www.example.com/. If the referer parameter is provided, up to 30 days of data can be queried. resourceType: filter by resource type. The resource type is generally a file suffix. Example value: .jpg. If the resourceType parameter is provided, data from the last 30 days can be queried at most; protocol: filter by HTTP protocol version. The corresponding value options are as follows: HTTP/1.0; HTTP/1.1; HTTP/2.0; HTTP/3; WebSocket. socket: filter by HTTP protocol type. The corresponding value options are as follows: HTTP: hypertext transfer protocol; HTTPS: HTTPS protocol; QUIC: QUIC protocol. statusCode: filter by edge status code. If the statusCode parameter is filled in, data from the last 30 days can be queried at most. The corresponding value options are as follows: 1XX: 1XX type status codes; 2XX: 2XX type status codes; 3XX: 3XX type status codes; 4XX: 4XX type status codes; 5XX: 5XX type status codes; integers within the range [0,600). browserType: filter by browser type. If the browserType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value are as follows: Firefox: Firefox browser; Chrome: Chrome browser; Safari: Safari browser; Other: Other browser types; Empty: 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: BIDUBrowser; TaoBrowser: TaoBrowser; UBrowser: UC browser. deviceType: filter by device type. If the deviceType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value are as follows: TV: TV device; Tablet: Tablet device; Mobile: Mobile device; Desktop: Desktop device; Other: Other device type; Empty: device type Empty. operatingSystemType: filter by operating system type. If the operatingSystemType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value 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: Bot: search engine crawler; Other: Other types of operating systems; Empty: operating system is Empty. tlsVersion: filter by TLS version. If the tlsVersion parameter is input, data from the last 30 days can be queried at most. The options for The corresponding value are as follows: TLS1.0; TLS1.1; TLS1.2; TLS1.3. ipVersion: filter by IP version. The options for the corresponding value are as follows: 4: IPv4; 6: IPv6. cacheType: filter by cache status. The options for The corresponding value are as follows: hit: request hits EdgeOne node cache, and resources are provided by node cache. partial cache hit for resources is also recorded as hit. miss: request does not hit EdgeOne node cache, and resources are provided by the origin server. dynamic: requested resources cannot be cached/unconfigured to be cached by node cache, and resources 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. If the clientIp parameter is filled in, data from the last 30 days can be queried at most. userAgent: filter by User-Agent request header. If the userAgent parameter is filled in, data from the last 30 days can be queried at most.
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 ownership region. this parameter is deprecated. Please filter data by client region in Filters.country.

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.intl.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": "path",
                        "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.