tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTimingL4Data

Last updated: 2023-03-09 17:41:52

1. API Description

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

This API is used to query the layer-4 time series traffic data.

A maximum of 20 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: DescribeTimingL4Data.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes Timestamp ISO8601 Client time in RFC 3339 format
EndTime Yes Timestamp ISO8601 Client time in RFC 3339 format
MetricNames.N Yes Array of String Supported metrics for data query:
l4Flow_connections: Access connections
l4Flow_flux: Access traffic
l4Flow_inFlux: Inbound traffic
l4Flow_outFlux: Outbound traffic
ZoneIds.N No Array of String List of site IDs
InstanceIds.N No Array of String This field has been disused. Use ProxyIds instead.
Protocol No String This field is not supported currently.
Interval No String Time interval. Valid values: {min, 5min, hour, day}
RuleId No String This field is not supported currently. Use Filter instead.
Filters.N No Array of Filter Supported filters: proxyd, ruleId
ProxyIds.N No Array of String List of layer-4 proxies

3. Output Parameters

Parameter Name Type Description
Type String Query dimension
Interval String Time interval
Data Array of TimingDataRecord Detailed data
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 the layer-4 time series traffic data

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data
<Common request parameters>

{
    "Protocol": "xx",
    "MetricNames": [
        "xx"
    ],
    "RuleId": "xx",
    "Interval": "xx",
    "ZoneIds": [
        "xx"
    ],
    "StartTime": "2020-09-22T00:00:00+00:00",
    "EndTime": "2020-09-22T00:00:00+00:00",
    "InstanceIds": [
        "xx"
    ]
}

Output Example

{
    "Response": {
        "Data": [
            {
                "TypeKey": "xx",
                "TypeValue": [
                    {
                        "Max": 0,
                        "Sum": 0,
                        "Detail": [
                            {
                                "Timestamp": 0,
                                "Value": 0
                            }
                        ],
                        "DetailData": [
                            0
                        ],
                        "Avg": 0,
                        "MetricName": "xx"
                    }
                ]
            }
        ],
        "Interval": "xx",
        "Type": "xx",
        "RequestId": "xx"
    }
}

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.ProxyServer An unknown error occurred in the backend server.
InternalError.RouteError The backend routing address is incorrect.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy