DescribeTimingL4Data
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the time series Data list of Layer 4.
.A maximum of 100 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: DescribeTimingL4Data. |
| 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 | Query metrics. valid values:.
|
| ZoneIds.N | Yes | Array of String | Site ID. this parameter will change from selectable to required after may 30, 2024. for details, see the announcement: tencent cloud EdgeOne: tencentcloud API change notification. Import up to 100 site ids. to query all site data under the tencent cloud root account, use * as a replacement. querying account-level data requires permission for all site resources of this api. |
| ProxyIds.N | No | Array of String | List of L4 proxy IDs. All L4 proxies will be selected if this field is not specified. |
| Interval | No | String | Time granularity of the query. valid values:.
min, 5min, hour, and day respectively when the period is no more than 1 hour, no more than 2 days, no more than 7 days, and over 7 days. |
| Filters.N | No | Array of QueryCondition | Filter criteria. the detailed Key values of filter criteria are as follows:.
|
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of query results. |
| Data | Array of TimingDataRecord | Layer 4 time series traffic Data list.
This API does not support dimension query for now. it aggregates and returns Data by root account by default, which means 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 Time Series Data for the Four-Layer Concurrent Connection Metric
Query the time series data of concurrent connections for all layer-4 instances under the selected site with ZoneId = zone-28kw53cmc6ky during the period from 2025-10-01T08:00:00+08:00 to 2025-10-01T10:00:00+08:00.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data
<Common request parameters>
{
"ZoneIds": [
"zone-28kw53cmc6ky"
],
"StartTime": "2025-10-01T08:00:00+08:00",
"EndTime": "2025-10-01T10:00:00+08:00",
"Interval": "hour",
"MetricNames": [
"l4Flow_connections"
]
}
Output Example
{
"Response": {
"RequestId": "e12e0659-ae34-4140-9878-4a61db0c3639",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 16,
"Detail": [
{
"Timestamp": 1759276800,
"Value": 15
},
{
"Timestamp": 1759280400,
"Value": 17
},
{
"Timestamp": 1759284000,
"Value": 0
}
],
"Max": 17,
"MetricName": "l4Flow_connections",
"Sum": 32
}
]
}
],
"TotalCount": 1
}
}
Example2 Query Total Access Traffic Time Series Data Based on Layer-4 Proxy Rule ID
Query the time series data of total access traffic for the layer-4 instance forwarding rule with RuleId = rule-033950bf-6fc4-11ed-8ab2-525400a22580 under the selected site with ZoneId = zone-28kw53cmc6ky during the period from 2025-10-01T08:00:00+08:00 to 2025-10-01T10:00:00+08:00.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data
<Common request parameters>
{
"ZoneIds": [
"zone-28kw53cmc6ky"
],
"StartTime": "2025-10-01T08:00:00+08:00",
"EndTime": "2025-10-01T10:00:00+08:00",
"Interval": "hour",
"MetricNames": [
"l4Flow_flux"
],
"Filters": [
{
"Key": "ruleId",
"Operator": "equals",
"Value": [
"rule-033950bf-6fc4-11ed-8ab2-525400a22580"
]
}
]
}
Output Example
{
"Response": {
"RequestId": "962792de-3bfe-483d-99a7-3cfde0467495",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [
{
"Avg": 5640,
"Detail": [
{
"Timestamp": 1671669600,
"Value": 3900
},
{
"Timestamp": 1671669900,
"Value": 7400
},
{
"Timestamp": 1671670800,
"Value": 5620
}
],
"Max": 7400,
"MetricName": "l4Flow_flux",
"Sum": 16920
}
]
}
],
"TotalCount": 1
}
}
Example3 Querying Time Series Data for the New Connection Rate Based on the Layer 4 Instance ID
Query the time series data of the rate of new connections for the layer-4 instance with ProxyId = sid-3kr5me8zidha at the selected site where ZoneId = zone-28kw53cmc6ky during the period from 2025-10-01T08:00:00+08:00 to 2025-10-01T10:00:00+08:00.
Note: Since the value type of l4Flow_newConnectionsRate in the queried metrics MetricNames is Float, the time series data corresponding to the l4Flow_newConnectionsRate metric is returned from Data.N.FloatTypeValue.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data
<Common request parameters>
{
"ZoneIds": [
"zone-28kw53cmc6ky"
],
"StartTime": "2025-10-01T08:00:00+08:00",
"EndTime": "2025-10-01T10:00:00+08:00",
"Interval": "hour",
"MetricNames": [
"l4Flow_newConnectionsRate"
],
"Filters": [
{
"Key": "proxyId",
"Operator": "equals",
"Value": [
"sid-3kr5me8zidha"
]
}
]
}
Output Example
{
"Response": {
"RequestId": "962792de-3bfe-483d-99a7-3cfde0467495",
"Data": [
{
"TypeKey": "251227260",
"TypeValue": [],
"FloatTypeValue": [
{
"Avg": 1.56,
"Detail": [
{
"Timestamp": 1671669600,
"Value": 1.08
},
{
"Timestamp": 1671669900,
"Value": 2.05
},
{
"Timestamp": 1671670800,
"Value": 1.56
}
],
"Max": 2.05,
"MetricName": "l4Flow_newConnectionsRate",
"Sum": 4.69
}
]
}
],
"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. |
| InternalError.RouteError | The backend routing address is incorrect. |
| LimitExceeded | The quota limit has been reached. |
| 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 Time Series Data for the Four-Layer Concurrent Connection Metric
- Example2 Query Total Access Traffic Time Series Data Based on Layer-4 Proxy Rule ID
- Example3 Querying Time Series Data for the New Connection Rate Based on the Layer 4 Instance ID
- 5. Developer Resources
- SDK
- Command Line Interface
- 6. Error Code