DescribePrepayBillTotal - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the billing overview of a subscription 2.0 instance.

Operation description

The statistics cover the current Cloud Firewall instance of the user, including all data since the purchase date.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribePrepayBillTotal

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language. Enumerated value. Default value: zh. Valid value: en.	zh
PageSize	integer	No	The number of entries per page. Default value: 10.	10
CurrentPage	integer	No	The page number in a paged query. Default value: 1.	1
StartTime	string	Yes	The start time of the query. Specify a UNIX timestamp in seconds. Note Because billing data is aggregated at the daily granularity, the timestamp must correspond to 00:00:00 of the day in CST (UTC+8). If the timestamp is not aligned to the start of the day, no data may be returned.	1656750960
EndTime	string	Yes	The end time. Specify a UNIX timestamp in seconds. Note Because billing data is aggregated at the daily granularity, the timestamp must correspond to 00:00:00 of the day in CST (UTC+8). If the timestamp is not aligned to the start of the day, no data may be returned.	1646063922
BillType	string	Yes	The bill type of the user. This parameter is required in practice. An error is returned if this parameter is not specified. Valid values: elastic_traffic: elastic traffic sdl: sensitive data leak detection traffic Valid values: sdl : Sensitive data leak detection traffic. elastic_traffic : Elastic traffic.	sdl

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	132
RequestId	string	The request ID.	450D47F5-956E-543E-8502-***********
BillList	array<object>	The bill list, aggregated by day.
	object
InternetTrafficBandwidth	number	The Internet traffic bandwidth. Unit: Gbit/s.	10
NatTrafficBandwidth	number	The NAT traffic bandwidth. Unit: Gbit/s.	10
VpcTrafficBandwidth	number	The VPC traffic bandwidth. Unit: Gbit/s.	10
OverflowTime	integer	The timestamp when the maximum bandwidth (Internet + VPC + NAT) of the day occurred.	1761588300
DefaultBandwidth	integer	The default bandwidth of the edition. Unit: Mbit/s.	200
ExtensionBandwidth	integer	The extended bandwidth. Unit: Mbit/s.	10
TemporaryBandwidth	integer	The temporary upgrade bandwidth. Unit: Mbit/s.	0
ElasticBandwidth	integer	The elastic bandwidth value. Unit: Mbit/s.	200
MonthlyRemainingFreeTraffic	number	The monthly free traffic for sensitive data detection. Unit: GB.	10
DailyDetectionTraffic	number	The sensitive data detection traffic of the day.	8
BilledDetectionTraffic	number	The actual billed traffic for sensitive data leak detection.	5
StartTime	integer	The start time of the day. The value is a UNIX timestamp in seconds.	1761580800
EndTime	integer	The end time of the day. The value is a UNIX timestamp in seconds.	1761667200
DailyOverflowTraffic	number	The total elastic traffic of the day. Unit: GB.	10

Examples

Success response

JSON format

{
  "TotalCount": 132,
  "RequestId": "450D47F5-956E-543E-8502-***********",
  "BillList": [
    {
      "InternetTrafficBandwidth": 10,
      "NatTrafficBandwidth": 10,
      "VpcTrafficBandwidth": 10,
      "OverflowTime": 1761588300,
      "DefaultBandwidth": 200,
      "ExtensionBandwidth": 10,
      "TemporaryBandwidth": 0,
      "ElasticBandwidth": 200,
      "MonthlyRemainingFreeTraffic": 10,
      "DailyDetectionTraffic": 8,
      "BilledDetectionTraffic": 5,
      "StartTime": 1761580800,
      "EndTime": 1761667200,
      "DailyOverflowTraffic": 10
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	The aliuid is invalid.	The aliuid is invalid.
400	ErrorNotPostpayUser	not Postpay User.	Non-pay-as-you-go Users.
400	ErrorTimeError	The time is invalid.	The time is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorMarshalJSON	internal error.	Internal error.
400	ErrorParamsInvalid	Invalid Params	The parameter is invalid.
400	ErrorDbFailed	Query db failed.	DB access error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.