DescribePrepayDailyBills - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the burstable pay-as-you-go billing details of a subscription WAF instance, such as burstable QPS.

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-waf:DescribePrepayDailyBills

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
InstanceId	string	Yes	The WAF instance ID. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-***
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The Alibaba Cloud resource group ID.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The request ID.	EC10C9EA-A367-52D5-*-*
Bills	array<object>	The list of WAF burstable billing records.
	object	The WAF burstable billing record.
Type	array	The burstable billing type.
	string	The burstable billing type. Valid values: base: basic traffic. bot: Bot Management. apisec: API Security.	base
ExceedStatus	integer	The overuse status of the current period. Valid values: 0: Normal. 1: overused. 2: sandboxed.	0
RiskControl	boolean	Indicates whether risk identification is enabled. Valid values: true: Risk identification is enabled. false: Risk identification is not enabled.	true
MaxQps	integer	The maximum QPS during the current period.	600
EndTime	integer	The end time of the billing record. The value is a UNIX timestamp (UTC). Unit: seconds.	1687591200
Price	number	The unit price for burstable billing. Unit: CNY for the China site and USD for the international site.	0.25
Qps	integer	The QPS extension specification of the WAF instance.	10
QpsVersion	integer	The QPS specification included in the WAF instance edition.	10
Total	integer	The total QPS that is billed.	0
StartTime	integer	The start time of the billing record. The value is a UNIX timestamp (UTC). Unit: seconds.	1687822980
RiskTraffic	integer	The number of times risk identification is used.	100
ElasticQpsSetValue	integer	The burstable QPS specification of the WAF instance.	100
ExtensionPlugin	boolean	Indicates whether the extension plug-in is enabled. Valid values: true: The extension plug-in is enabled. false: The extension plug-in is not enabled.	true
ExtensionPluginRequest	integer	The number of requests processed by the plug-in.	100

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "EC10C9EA-A367-52D5-***-***",
  "Bills": [
    {
      "Type": [
        "base"
      ],
      "ExceedStatus": 0,
      "RiskControl": true,
      "MaxQps": 600,
      "EndTime": 1687591200,
      "Price": 0.25,
      "Qps": 10,
      "QpsVersion": 10,
      "Total": 0,
      "StartTime": 1687822980,
      "RiskTraffic": 100,
      "ElasticQpsSetValue": 100,
      "ExtensionPlugin": true,
      "ExtensionPluginRequest": 100
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.