DescribeChargeResult - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the billing results for WAF.

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:DescribeChargeResult

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
PayType	string	Yes	The billing method of the WAF instance. Valid value: POSTPAY: pay-as-you-go.	POSTPAY
ChargeCycle	string	No	The billing cycle. Valid values: Year: Calculates the bill for one year. Month: Calculates the bill for one month. Day: Calculates the bill for one day.	Day
ChargeModules	array<object>	Yes	The billing modules to calculate.
	object	No	A billing module to calculate.
ModuleCode	string	No	The ID of the billing module.	domainCount
Usage	integer	No	The usage amount of the billing module.	10

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
TotalSeCu	number	The total number of calculated Security Capacity Units (SeCUs).	1080
ModuleDetails	array<object>	Details of the calculation results.
	object	The calculation result for a billing module.
ModuleCode	string	The ID of the billing module.	domainCount
SeCu	number	The number of SeCUs for the billing module.	1080

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "TotalSeCu": 1080,
  "ModuleDetails": [
    {
      "ModuleCode": "domainCount",
      "SeCu": 1080
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.