All Products
Search
Document Center

Cloud Firewall:DescribePrepayBillTotal

Last Updated:Jun 29, 2026

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language. Valid values:

  • zh

  • en

Default value: zh.

zh

PageSize

integer

No

The number of entries per page. Default value: 10.

10

CurrentPage

integer

No

The page number for a paged query. Default value: 1.

1

StartTime

string

Yes

The start time of the query. Specify a UNIX timestamp in seconds.

1656750960

EndTime

string

Yes

The end time. Specify a UNIX timestamp in seconds.

1646063922

BillType

string

No

The billing type. 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 combined bandwidth (Internet + VPC + NAT) occurred on that day.

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. Unit: Mbit/s.

200

MonthlyRemainingFreeTraffic

number

The monthly free traffic quota for sensitive data detection. Unit: GB.

10

DailyDetectionTraffic

number

The sensitive data detection traffic for 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 for 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.