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 services by a specified dimension.
Notes:
- There is a delay of about 10 minutes for this API. It is recommended to query data from 10 minutes before the current time.
- By default, the API returns traffic and request data after Web Security mitigation (that is, the clean traffic). Users can set
Filters.mitigatedByWebSecurityto query data that has been mitigated by Web Security.
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 | End time. The query time range (EndTime - StartTime) must be less than or equal to 31 days. |
| MetricName | Yes | String | Queried metric. Valid values: |
| ZoneIds.N | No | Array of String | Site ID list. This parameter is required. A maximum of 100 site IDs can be imported. Use * to query data for all sites under the Tencent Cloud root account. To query account-level data, you must have resource permissions for all sites in this API. |
| 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 | Filtering conditions used when querying data. Refer to the Filtering Conditions for Analytics document for the available filters applicable to L7 client traffic, bandwidth and requests. |
| Interval | No | String | Query time granularity. This parameter is deprecated. |
| Area | No | String | Data 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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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. |