DescribeTimingL7AnalysisData
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query time-series data for Layer 7 domain services.
Notes:
- Data queried by this API has a latency of approximately 10 minutes. It is recommended to pull data from at least 10 minutes prior to the current time.
- By default, this API returns post-protection traffic request data. Users can customize queries for mitigated data by using
Filters.mitigatedByWebSecurity.
A maximum of 30 requests can be initiated per second for this API.
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 | Start time. |
| EndTime | Yes | Timestamp ISO8601 | End time. The query time range ( |
| MetricNames.N | Yes | Array of String | Metric list. Valid values: |
| ZoneIds.N | No | Array of String | Site ID set. This parameter will change from optional to required after May 30, 2024. For details, see the notice: [Tencent Cloud EdgeOne] Cloud API Change Notification. A maximum of 100 site IDs can be imported. To query all site data under the Tencent Cloud root account, use |
| Interval | No | String | Query time granularity. Enumeration values:
If this parameter is not input, 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 | Filter conditions used when filtering data. For available filter options, refer to the Analytics Filter Options for L7 client traffic, bandwidth, and request counts. |
| Area | No | String | The region to which the data belongs. This parameter is deprecated. To filter data by client region, use |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The total number of records in the query result. |
| Data | Array of TimingDataRecord | Layer-7 time series traffic data list.
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 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.
- 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. |