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.
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: GetFlowStatisticByName. |
| 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. |
| DeviceName | Yes | String | Device name. |
| 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 name list. Used for querying traffic volume across devices. When this field is enabled, DeviceId can be "-1". |
| 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. |
POST / HTTP/1.1
Host: mna.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFlowStatisticByName
<Common request parameters>
{
"DeviceName": "test0916",
"BeginTime": 1757865600,
"EndTime": 1758544927,
"Type": 1,
"TimeGranularity": 1
}
{
"Response": {
"AvgValue": 51145200,
"MaxValue": 51145200,
"NetDetails": [
{
"Current": 51145200,
"Time": "1758024000"
}
],
"RequestId": "3dc9c965-862b-46ea-b80a-0caf4368d0ba",
"TotalValue": 51145200
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
피드백