Domain name for API request: cfw.intl.tencentcloudapi.com.
This API is used to query the traffic statistics under VPC firewalls at the single IP granularity.
A maximum of 3 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: DescribeVpcFwIpStat. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-04. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Limit | Yes | Integer | Entries per page |
| Offset | Yes | Integer | Offset value |
| FwGroupId | No | String | Firewall group ID |
| FwInsId | No | String | Instance id of the firewall |
| TimeType | No | Integer | Selected time interval 1: within an hour, 2: 24 hours, 3: 7 days, 4: 1 month |
| Filters.N | No | Array of CommonFilter | Filter condition composite |
| StartTime | No | String | Start time of retrieval. Can be omitted. |
| EndTime | No | String | End time of retrieval. Can be omitted. |
| Order | No | String | desc: descending order; asc: ascending order. Sort by the value of the By field. If any parameters are loaded, by must have a value. |
| By | No | String | Fields used for sorting |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of FwGroupIpFlowStat | Peak bandwidth statistics list for a single cvm |
| Total | Integer | Total number of lines |
| Status | Integer | Asynchronously query status. 1 indicates query execution in progress, and 0 indicates query stopped. |
| 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. |
Traffic sample code
POST / HTTP/1.1
Host: cfw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpcFwIpStat
<Common request parameters>
{
"Limit": 10,
"Offset": 0
}{
"Response": {
"Data": [
{
"Ip": "192.168.1.1",
"InstanceId": "ins - a0eksp50",
"InstanceName": "andy's instance",
"VpcId": "vpc - a0eksp50",
"VpcName": "VPC name"
"FlowMax": 11,
"FlowAvg": 2222,
"TcRuleStatus": 1,
"FwInsId": "cfwew - a0eksp50",
"IpVersion": 1
}
],
"RequestId": "128c5a96-3656-45a3-968b-14d35529e18e",
"Total": 0
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded | The quota limit has been reached. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
フィードバック