tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTopL7AnalysisData

Last updated: 2023-03-09 17:41:52

1. API Description

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

This API is used to query the top traffic data.

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: DescribeTopL7AnalysisData.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes Timestamp ISO8601 Client time in RFC 3339 format
EndTime Yes Timestamp ISO8601 Client time in RFC 3339 format
MetricName Yes String Time series-type access traffic metric
Limit Yes Integer Top N. 0 indicates to return the full data.
Interval Yes String Time interval. Valid values: {min, 5min, hour, day, week}
ZoneIds.N No Array of String Array of ZoneId values
Filters.N No Array of Filter Filter

3. Output Parameters

Parameter Name Type Description
Data Array of TopDataRecord Top detailed data
Note: This field may return null, indicating that no valid values can be obtained.
Type String Query dimension
MetricName String Query metric
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the layer-7 top traffic data for data analysis

This example shows you how to query the layer-7 top traffic data for data analysis.

Input Example

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

{
    "StartTime": "2020-09-22T00:00:00+00:00",
    "Interval": "xx",
    "ZoneIds": [
        "xx"
    ],
    "Limit": 0,
    "Filters": [
        {
            "Operator": "xx",
            "Value": [
                "xx"
            ],
            "Key": "xx"
        }
    ],
    "EndTime": "2020-09-22T00:00:00+00:00",
    "MetricName": "xx"
}

Output Example

{
    "Response": {
        "Type": "xx",
        "Data": {
            "DetailData": [
                {
                    "Value": 3000,
                    "Key": "xx"
                },
                {
                    "Key": "xx",
                    "Value": 5000
                },
                {
                    "Key": "xx",
                    "Value": 8000
                }
            ],
            "TypeKey": "xx"
        },
        "RequestId": "xx",
        "MetricName": "xx"
    }
}

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

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.
OperationDenied Operation denied.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy