tencent cloud

Feedback

DescribeOverviewL7Data

Last updated: 2024-02-21 20:20:10

    1. API Description

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

    This API is used to query the time sequence traffic data of the monitoring category in L7. This API is to be discarded. Please use the API DescribeTimingL7AnalysisData.

    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: DescribeOverviewL7Data.
    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.
    MetricNames.N Yes Array of String The metric to query. Values:
  • l7Flow_outFlux: Traffic used for EdegOne responses
  • l7Flow_inFlux: Traffic used for EdegOne requests
  • l7Flow_outBandwidth: Bandwidth used for EdegOne responses
  • l7Flow_inBandwidth: Bandwidth used for EdegOne requests
  • l7Flow_hit_outFlux: Traffic used for cache hit
  • l7Flow_request: Access requests
  • l7Flow_flux: Upstream and downstream traffic used for client access
  • l7Flow_bandwidth: Upstream and downstream bandwidth used for client access
  • ZoneIds.N No Array of String ZoneId set. This parameter is required.
    Domains.N No Array of String Queried domain name set. This parameter has been discarded.
    Protocol No String The protocol type. Values:
  • http: HTTP protocol;
  • https: HTTPS protocol;
  • http2: HTTP2 protocol;
  • all: All protocols.
  • If it’s not specified, all is used. This parameter is not yet available now.
    Interval No String The query granularity. Values:
  • min: 1 minute;
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: One day
  • If this field is not specified, the granularity will be determined based on the query period.
    Period ≤ 1 hour: min;
    1 hour < Period ≤ 2 days: 5min;
    2 days < period ≤ 7 days: hour;
    Period > 7 days: day.
    Filters.N No Array of QueryCondition Filtering condition. The detailed filtering condition key values are as follows:
  • socket
    u2003u2003 Filter based on [HTTP protocol type].
    u2003u2003 Corresponding value options:
    u2003u2003 HTTP: HTTP protocol;
    u2003u2003 HTTPS: HTTPS protocol;
    u2003u2003 QUIC: QUIC protocol.
  • domains
    u2003u2003 Filter based on [domain name].
  • tagKey
    u2003u2003 Filter based on [Tag Key].
  • tagValue
    u2003u2003 Filter based on [Tag Value].
  • Area No String Geolocation scope. 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 TimingDataRecord The list of L7 traffic summary statistics recorded over time.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying L7 Monitoring Time Sequence Traffic Data

    Indicator for the number of L7 monitoring data query requests

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeOverviewL7Data
    <Common request parameters>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l7Flow_request"
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "6cc74d08-c174-413a-976b-abe7b851e010",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 1564,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1659225600,
                                    "Value": 0
                                }
                            ],
                            "Max": 8037,
                            "MetricName": "l7Flow_request",
                            "Sum": 48511
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }
    

    Example2 Querying Time Sequence Traffic Data based on the Tag

    Obtain the indicator for the number of requests based on the filtering conditions of tags.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeOverviewL7Data
    <Common request parameters>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l7Flow_request"
        ],
        "Filters": [
            {
                "Key": "tagKey",
                "Operator": "equals",
                "Value": [
                    "test1"
                ]
            },
            {
                "Key": "tagValue",
                "Operator": "equals",
                "Value": [
                    "a.com",
                    "b.com"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "6cc74d08-c174-413a-976b-abe7b851e0121",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 1564,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 100
                                },
                                {
                                    "Timestamp": 1659225600,
                                    "Value": 34
                                }
                            ],
                            "Max": 8037,
                            "MetricName": "l7Flow_request",
                            "Sum": 48511
                        }
                    ]
                }
            ],
            "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

    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.RouteError The backend routing address is incorrect.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded.QueryTimeLimitExceeded Query time limit exceeded.
    ResourceNotFound The resource doesn’t exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support