Retrieves the traffic trend of a virtual private cloud (VPC) firewall.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Lang |
string |
No |
The language of the request and response. Valid values:
Valid values:
|
zh |
| StartTime |
string |
Yes |
The start time. The value is a UNIX timestamp. Unit: seconds. |
1780626107 |
| EndTime |
string |
Yes |
The end time. The value is a UNIX timestamp. Unit: seconds. |
1767493189 |
| VpcId |
string |
Yes |
The instance ID of the VPC-connected instance. |
vpc-j6cnofg4lg1ujx3xj**** |
| PeerVpcId |
string |
No |
The instance ID of the peer VPC instance. |
vpc-j6c7mscdg4hfqanfi**** |
| PrivateIP |
string |
No |
The private IP address. |
10.21.186.XXX |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| MaxTotalBps |
integer |
The peak total network throughput in both the outbound and inbound directions. Unit: bit/s. |
61947852 |
| AvgInBps |
integer |
The average inbound network throughput. Unit: bit/s. |
1264110 |
| RequestId |
string |
The request ID. |
45F8B9E6-8583-56B3-A127-1B421C9E**** |
| MaxInBps |
integer |
The peak inbound network throughput. Unit: bit/s. |
1436 |
| MaxOutBps |
integer |
The peak outbound network throughput. Unit: bit/s. |
2128 |
| AvgSession |
integer |
The average number of requests. |
1995 |
| MaxSession |
integer |
The peak number of requests. |
2003 |
| AvgTotalBps |
integer |
The average total network throughput in both the outbound and inbound directions. Unit: bit/s. |
34291 |
| AvgOutBps |
integer |
The average outbound network throughput. Unit: bit/s. |
68915 |
| MaxBandwidthTime |
integer |
The timestamp when the peak bandwidth occurred. The value is a UNIX timestamp. Unit: seconds. |
1768008060 |
| TotalInBytes |
integer |
The total inbound network throughput. Unit: bytes. |
2659635037 |
| TotalOutBytes |
integer |
The total outbound network throughput. Unit: bytes. |
399762701 |
| TotalBytes |
integer |
The total traffic. Unit: bytes. |
141688156232 |
| TotalSession |
integer |
The total number of requests. |
1078757 |
| DataList |
array<object> |
The data list. |
|
|
object |
The data list. |
||
| SessionCount |
integer |
The number of sessions. |
27 |
| Time |
integer |
The time when the traffic occurred. The value is a UNIX timestamp. Unit: seconds. |
1758470400 |
| InBps |
integer |
The inbound bandwidth. Unit: bit/s. |
187 |
| InPps |
integer |
The inbound packet forwarding rate. Unit: pps. |
2 |
| NewConn |
integer |
The number of new connections. |
27 |
| OutBytes |
integer |
The total outbound network throughput. Unit: bytes. |
230 |
| OutPps |
integer |
The outbound packet forwarding rate. Unit: pps. |
2 |
| InBytes |
integer |
The inbound traffic. Unit: bytes. |
32 |
| OutBps |
integer |
The outbound traffic. Unit: bytes. |
45 |
Examples
Success response
JSON format
{
"MaxTotalBps": 61947852,
"AvgInBps": 1264110,
"RequestId": "45F8B9E6-8583-56B3-A127-1B421C9E****",
"MaxInBps": 1436,
"MaxOutBps": 2128,
"AvgSession": 1995,
"MaxSession": 2003,
"AvgTotalBps": 34291,
"AvgOutBps": 68915,
"MaxBandwidthTime": 1768008060,
"TotalInBytes": 2659635037,
"TotalOutBytes": 399762701,
"TotalBytes": 141688156232,
"TotalSession": 1078757,
"DataList": [
{
"SessionCount": 27,
"Time": 1758470400,
"InBps": 187,
"InPps": 2,
"NewConn": 27,
"OutBytes": 230,
"OutPps": 2,
"InBytes": 32,
"OutBps": 45
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorTrafficType | The traffic type is invalid. | The traffic type is invalid. |
| 400 | ErrorVpcId | The VPC ID is invalid. | The VPC ID is invalid. |
| 400 | ErrorIntervalError | The interval is invalid. | The interval is invalid. |
| 400 | ErrorTimeError | The time is invalid. | The time is invalid. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorDataTypeError | The data type is invalid. | The data type is invalid. |
| 400 | ErrorMarshalJSON | internal error. | Internal error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.