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
- ExportZoneConfig
- ImportZoneConfig
- DescribeZoneConfigImportResult
Acceleration Domain Management APIs
- CreateAccelerationDomain
- DescribeAccelerationDomains
- ModifyAccelerationDomain
- ModifyAccelerationDomainStatuses
- DeleteAccelerationDomains
- CreateSharedCNAME
- BindSharedCNAME
- DeleteSharedCNAME
Site Acceleration Configuration APIs
- CreateRule
- DeleteRules
- DescribeHostsSetting
- DescribeRules
- DescribeRulesSetting
- DescribeZoneSetting
- ModifyRule
- ModifyZoneSetting
Edge Function APIs
- CreateFunction
- DescribeFunctions
- ModifyFunction
- CreateFunctionRule
- DeleteFunction
- DescribeFunctionRules
- ModifyFunctionRule
- ModifyFunctionRulePriority
- DeleteFunctionRules
- DescribeFunctionRuntimeEnvironment
- HandleFunctionRuntimeEnvironment
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
- CreateLoadBalancer
- ModifyLoadBalancer
- DeleteLoadBalancer
- DescribeLoadBalancerList
- DescribeOriginGroupHealthStatus
Custom Response Page APIs
- CreateCustomizeErrorPage
- DescribeCustomErrorPages
- ModifyCustomErrorPage
- DeleteCustomErrorPage
DNS Record APIs
- CreateDnsRecord
- DeleteDnsRecords
- DescribeDnsRecords
- ModifyDnsRecordsStatus
- ModifyDnsRecords
Diagnostic Tool APIs
- DescribeIPRegion
Version Management APIs
- CreateConfigGroupVersion
- DeployConfigGroupVersion
- DescribeConfigGroupVersionDetail
- DescribeConfigGroupVersions
- DescribeDeployHistory
- DescribeEnvironments
Data Types
Error Codes

DescribeTimingL7AnalysisData

1. API Description

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

This API is used to query time-series data for L7 domain services.
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.mitigatedByWebSecurity to 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: DescribeTimingL7AnalysisData.
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.
MetricNames.N	Yes	Array of String	Metric list. Valid values: l7Flow_outFlux: L7 EdgeOne response traffic. Unit: byte; l7Flow_inFlux: L7 client request traffic. Unit: byte; l7Flow_flux: L7 total traffic (including EdgeOne response traffic and client request traffic). Unit: byte; l7Flow_outBandwidth: L7 EdgeOne response bandwidth. Unit: bps; l7Flow_inBandwidth: L7 client request bandwidth. Unit: bps; l7Flow_bandwidth: L7 total bandwidth (including EdgeOne response bandwidth and client request bandwidth). Unit: bps; l7Flow_request: L7 request count. Unit: times; l7Flow_avgResponseTime: Average L7 edge response time. Unit: ms (milliseconds); l7Flow_avgFirstByteResponseTime: Average L7 edge first byte response time. Unit: ms.
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.
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.
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. To restrict results by zone or content identifier, input the corresponding values via the `ZoneIds.N` parameter.
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 TimingDataRecord	The list of L7 traffic data recorded over time. Note: This field may return null, indicating that no valid values can be obtained.
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 Time Series Data of the Request Count by HTTP Protocol Version

This example shows you how to query the request count metric data by HTTP protocol version.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData
<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": "protocol",
            "Operator": "equals",
            "Value": [
                "HTTP/1.0",
                "HTTP/1.1"
            ]
        }
    ],
    "ZoneIds": [
        "zone-2o7b38ba1hvr"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
        "Data": [
            {
                "TypeKey": "251227260",
                "TypeValue": [
                    {
                        "Avg": 803,
                        "Detail": [
                            {
                                "Timestamp": 1659139200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1661731200,
                                "Value": 0
                            }
                        ],
                        "Max": 7921,
                        "MetricName": "l7Flow_request",
                        "Sum": 24918
                    }
                ]
            }
        ],
        "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.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Querying the Time Series Data of the Request Count by HTTP Protocol Version
5. Developer Resources
SDK
Command Line Interface
6. Error Code