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

DescribeOverviewL7Data

1. API Description

Domain name for API request: teo.intl.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeOverviewL7Data.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
StartTimeYesTimestamp ISO8601Start time.
EndTimeYesTimestamp ISO8601End time.
MetricNames.NYesArray of StringQueried metric. Valid values:
  • l7Flow_outFlux: EdgeOne response traffic;
  • l7Flow_inFlux: EdgeOne request traffic;
  • l7Flow_outBandwidth: EdgeOne response bandwidth;
  • l7Flow_inBandwidth: EdgeOne request traffic;
  • l7Flow_hit_outFlux: cache hit traffic;
  • l7Flow_request: number of access requests;
  • l7Flow_flux: upstream and downstream traffic of access requests;
  • l7Flow_bandwidth: upstream and downstream bandwidths of access requests.
  • ZoneIds.NNoArray of StringSite ID set. This parameter is required.
    Domains.NNoArray of StringQueried domain name set. This parameter has been deprecated.
    ProtocolNoStringProtocol type of the query. Valid values:
  • http: HTTP protocol;
  • https: HTTPS protocol;
  • http2: HTTP/2 protocol;
  • all: all protocols.
  • If this parameter is not input, the default value all is used. This parameter is not yet effective.
    IntervalNoStringTime granularity of the query. Valid values:
  • min: 1 minute;
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
  • If this parameter is not input, the granularity will be automatically inferred based on the interval between the start time and end time. Specifically, the granularity value is min, 5min, hour, and day respectively for queries of data within 1 hour, within 2 days, within 7 days, and over 7 days.
    Filters.NNoArray of QueryConditionFilter criteria. The detailed Key values of filter criteria are as follows:
  • socket:
    Filter by [HTTP protocol type].
    Valid values:
    HTTP: HTTP protocol;
    HTTPS: HTTPS protocol;
    QUIC: QUIC protocol.
  • domain
    ?? Filter by [domain name].
  • tagKey
    ?? Filter by [tag key].
  • tagValue
    ?? Filter by [tag value].
  • AreaNoStringData ownership area. Valid values:
  • overseas: global (excluding the Chinese mainland) data;
  • mainland: Chinese mainland data;
  • global: global data.
  • If this parameter is not input, the default value global is used.

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerTotal number of entries in the query result.
    DataArray of TimingDataRecordList of time series traffic data in L7 monitoring.
    Note: This field may return null, which indicates a failure to obtain a valid value.
    RequestIdStringThe 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 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.intl.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
        }
    }
    

    Example2 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.intl.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
        }
    }
    

    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 CodeDescription
    FailedOperationOperation failed.
    InternalError.RouteErrorThe backend routing address is incorrect.
    InvalidParameterParameter error.
    InvalidParameterValueInvalid parameter value.
    LimitExceeded.QueryTimeLimitExceededQuery time limit exceeded.
    ResourceNotFoundThe resource doesn’t exist.
    ResourceUnavailableThe resource is unavailable.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.