DescribePostpayTrafficTotal - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the total volume of traffic that is billed based on the pay-as-you-go billing method, including all firewalls within the current account.

Operation description

You can call this operation to query statistics of the current Cloud Firewall from the date of purchase.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:DescribePostpayTrafficTotal	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the response. Valid values: zh (default): Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object
TotalAssets	long	The total number of assets protected all types of firewalls.	132
RequestId	string	The ID of the request.	826B6280-9704-5643-97B1-6B47AC3F027A
TotalTraffic	long	The total volume of traffic. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic. Unit: bytes.	2320274874426
TotalNatAssets	long	The total number of assets protected by NAT firewalls.	1
TotalNatTraffic	long	The total traffic for NAT firewalls. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the NAT boundary. Unit: bytes.	560646279
TotalVpcAssets	long	The total number of assets protected by virtual private cloud (VPC) firewalls.	3
TotalVpcTraffic	long	The total traffic for VPC firewalls. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the VPC boundary. Unit: bytes.	2320274874426
TotalInternetAssets	long	The total number of assets protected by the Internet firewall.	128
TotalInternetTraffic	long	The total traffic for the Internet firewall. If you use Cloud Firewall that uses the subscription billing method, this parameter indicates the total volume of burstable protected traffic on the Internet boundary. Unit: bytes.	2320274874426
TotalBillTraffic	long	The volume of burstable protected traffic for which fees are generated. Unit: bytes.	2320274874426

Examples

Sample success responses

JSONformat

{
  "TotalAssets": 132,
  "RequestId": "826B6280-9704-5643-97B1-6B47AC3F027A",
  "TotalTraffic": 2320274874426,
  "TotalNatAssets": 1,
  "TotalNatTraffic": 560646279,
  "TotalVpcAssets": 3,
  "TotalVpcTraffic": 2320274874426,
  "TotalInternetAssets": 128,
  "TotalInternetTraffic": 2320274874426,
  "TotalBillTraffic": 2320274874426
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorNotPostpayUser	not Postpay User.	Non-pay-as-you-go Users.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-29	API Description Update. The Error code has changed	View Change Details
2024-06-05	The response structure of the API has changed	View Change Details