tencent cloud

GetFlowStatistic

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-21 10:26:24

1. API Description

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

Retrieve traffic usage data for a specified device Id at a specified time point.

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: GetFlowStatistic.
Version Yes String Common Params. The value used for this API: 2021-01-19.
Region No String Common Params. This parameter is not required for this API.
DeviceId Yes String device ID
BeginTime Yes Integer Search start time
EndTime Yes Integer end time
Type Yes Integer Traffic type (1: uplink traffic, 2: downstream traffic, 3: sum of upstream and downstream)
TimeGranularity Yes Integer Time granularity (1: hourly statistics, 2: daily statistics)
AccessRegion No String Access region. Value ranges from 'MC' to 'AM'. MC=Chinese mainland AP=Asia Pacific EU=Europe AM=Americas. Leave it blank to represent all regions.
GatewayType No Integer Gateway type. 0: public cloud gateway; 1: private gateway. Default is 0 if not specified.
DeviceList.N No Array of String Device ID list. Used for querying traffic volume across devices. When this field is enabled, DeviceId can be "-1".

3. Output Parameters

Parameter Name Type Description
NetDetails Array of NetDetails Traffic details
MaxValue Float Search the maximum value of traffic usage in a time period (measurement unit: byte)
AvgValue Float Search time period traffic usage average (unit: byte)
TotalValue Float Search total traffic usage in the time period (unit: byte)
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 Retrieve Traffic Usage for Specified id Device

Retrieve traffic usage for the specified id device

Input Example

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

{
    "EndTime": 1659514692,
    "Type": 1,
    "DeviceId": "mna-dev1",
    "TimeGranularity": 1,
    "BeginTime": 1659513692
}

Output Example

{
    "Response": {
        "MaxValue": 51548,
        "AvgValue": 15441,
        "TotalValue": 656546,
        "NetDetails": [
            {
                "Time": "1659513692",
                "Current": 3546545
            },
            {
                "Time": "1659513692",
                "Current": 4454864
            },
            {
                "Time": "1659513692",
                "Current": 4848941
            }
        ],
        "RequestId": ""
    }
}

Example2 Retrieve the sum of traffic usage for multiple devices

Input Example

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

{
    "EndTime": 1659514692,
    "Type": 1,
    "DeviceId": "",
    "DeviceList": [
        "mna-dev1",
        "mna-dev2"
    ],
    "TimeGranularity": 1,
    "BeginTime": 1659513692
}

Output Example

{
    "Response": {
        "MaxValue": 51548,
        "AvgValue": 15441,
        "TotalValue": 656546,
        "NetDetails": [
            {
                "Time": "1659513692",
                "Current": 3546545
            },
            {
                "Time": "1659513692",
                "Current": 4454864
            },
            {
                "Time": "1659513692",
                "Current": 4848941
            }
        ],
        "RequestId": ""
    }
}

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
InternalError Internal error.
InternalError.ControlRequestError Request controller encounters an error.
InternalError.MonitorDataRequestError Monitor data request error.
InternalError.NetworkInfoRequestError Zhiyan traffic data request error.
InvalidParameterValue Parameter value error.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan