All Products
Search

This Product

    Web Application Firewall:DescribeChargeModule

    Document Center

    Web Application Firewall:DescribeChargeModule

    Last Updated:Mar 22, 2026

    Retrieves the billing module information of Web Application Firewall (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

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    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 ID of the resource group.

    rg-acfm***q

    PayType

    string

    Yes

    The billing method of the instance. Valid values:

    • POSTPAY: a pay-as-you-go WAF instance.

    POSTPAY

    Response elements

    Element

    Type

    Description

    Example

    object

    The result of the request.

    RequestId

    string

    The ID of the request.

    D7861F61-5B61-46CE-A47C-6B19160D5EB0
    ChargeModules

    array<object>

    A list of billing modules for WAF.

    object

    The information about a billing module for WAF.

    ModuleCode

    string

    The code of the billing module. Valid values:

    • domainCount: the number of domain names added to WAF in CNAME record mode.

    • qps: the peak queries per second (QPS).

    • request: the basic traffic fee.

    • ipBlacklistRuleCount: the number of IP blacklist rules.

    • customAclBaseRuleCount: the number of basic rules in custom protection rules.

    • customAclAdvanceRuleCount: the number of advanced rules in custom protection rules.

    • antiScanRuleCount: the number of scan protection rules.

    • customResponseRuleCount: the number of custom response rules.

    • ipv6: IPv6 protection.

    • gslb: intelligent load balancing.

    • exclusiveIpCount: the number of exclusive IP addresses.

    • ccRuleCount: the number of HTTP flood protection rules.

    • regionBlockRuleCount: the number of rules in the region blacklist.

    • tamperproofRuleCount: the number of web tamper-proofing rules.

    • dlpRuleCount: the number of data leakage prevention rules.

    • botTraffic: the traffic fee for bot management.

    • aiWhiteListTemplateCount: the number of intelligent whitelist templates.

    • apisecResourceCount: the number of protected objects for which API security is enabled.

    • apisecTraffic: the traffic fee for API security.

    • compliance: the number of protocol compliance templates.

    • riskTraffic: the number of times that risk identification in bot management is matched.

    • assetStatus: asset center.

    • nonPort: custom ports protection.

    • customAclCaptcha: the number of times that sliders are used for custom protection rules.

    • wafBaseTemplateCount: the number of core web protection rules.

    • instanceFee: the WAF instance fee.

    • spikeThrottleRuleCount: the number of peak traffic throttling rules.

    • botWebTemplateCount: the number of web protection templates in bot management.

    • botAppTemplateCount: the number of app protection templates in bot management.

    • customAclBotRuleCount: the number of advanced custom rules in bot management.

    domainCount

    PeriodType

    string

    The billing cycle of the billing module. Valid values:

    • Hour: hourly billing.

    Hour

    UsageType

    string

    The usage type of the billing module. Valid values:

    • template: template.

    • qps: QPS.

    • domain: domain name.

    • rule: rule.

    • ip: IP address.

    • resource: protected object.

    • request: request.

    • function: feature enablement.

    • time: number of times.

    domain

    UsageUnitFactor

    integer

    The billing unit coefficient of the billing module.

    Note

    The usage unit for the module is determined by multiplying the UsageUnitFactor by the UsageType.

    1

    ChargeMode

    string

    The pricing model of the billing module. Valid values:

    • NORMAL_PRICE: tiered pricing.

    • STEP_ACCUMULATION: tiered pricing.

    NORMAL_PRICE
    ChargeModeDetails

    array

    The detailed pricing information for the billing module.

    string

    The detailed pricing information for the billing module. The information is a string converted from a JSON object.

    Note

    If ChargeMode is set to NORMAL_PRICE, the JSON object contains only the number of CUs for the billing module.

    • When the ChargeMode pricing model is STEP_ACCUMULATION, the range field in the JSON represents the tiered pricing information.

    { "cu": 5.0, "range": { "type": "lcrc", "min": "2", "max": "10" } }

    Examples

    Success response

    JSON format

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "ChargeModules": [
    {
      "ModuleCode": "domainCount",
      "PeriodType": "Hour",
      "UsageType": "domain",
      "UsageUnitFactor": 1,
      "ChargeMode": "NORMAL_PRICE",
      "ChargeModeDetails": [
        "{\n\"cu\": 5.0,\n\"range\": {\n\"type\": \"lcrc\", \n      \"min\": \"2\",\n      \"max\": \"10\"\n  }\n}"
      ]
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.