Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Your Subscriptions/ Enabling Pay-Per-Use Billing for Cloud WAF
Updated on 2026-05-12 GMT+08:00

Enabling Pay-Per-Use Billing for Cloud WAF

Function

This API is used to enable the pay-per-use billing mode for cloud WAF.

Constraints

This function is not supported in the CN North-Beijing2, CN East-Qingdao, TR-Istanbul, or ME-Abu Dhabi region.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/postpaid

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

region

Yes

String

Definition

Region ID.

Constraints

Region IDs supported by Huawei Cloud.

Range

N/A

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

console_area

Yes

String

Site your services are running.

  • hec-hk: Huawei Cloud (International)

  • hws: Huawei Cloud (China)

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

type

Integer

Version of the created cloud instance. When creating a pay-per-use API, 22 is returned by default.

  • 22: pay-per-use edition

resources

Array of ResourceResponse objects

The resource list.

isNewUser

Boolean

Whether you are a new user.

Table 6 ResourceResponse

Parameter

Type

Description

resourceId

String

Definition

Resource ID

Range

N/A

cloudServiceType

String

Definition

Cloud service category

Range

N/A

resourceType

String

Definition

Cloud service resource type

Range

  • hws.resource.type.waf: yearly/monthly cloud-mode WAF

  • hws.resource.type.waf.domain: domain name expansion packages in yearly/monthly cloud-mode WAF

  • hws.resource.type.waf.bandwidth: yearly/monthly bandwidth expansion package for cloud WAF instances

  • hws.resource.type.waf.rule: cloud mode yearly/monthly WAF rule expansion package

  • hws.resource.type.waf.payperuserequest: requests to pay-per-use WAF instances

  • hws.resource.type.waf.payperusedomain: domain names protected with pay-per-use WAF instances

  • hws.resource.type.waf.payperuserule: rules created in pay-per-use WAF instances

resourceSpecCode

String

Definition

Cloud service resource specifications

Range

N/A

status

Integer

Definition

Resource status

Range

  • 0: unfrozen/normal

  • 1: frozen

  • 2: delete

expireTime

String

Definition

Expires

Range

N/A

resourceSize

Integer

Definition

Quantity

Range

N/A

timestamp

Long

Definition

Resource creation time.

Range

N/A

relativeType

Integer

Definition

When the resource is an auxiliary resource, such as domain name extension package, bandwidth extension package, rule extension package, or advanced function extension package, this parameter describes the relationship between the auxiliary resource and the primary resource.

Range

  • 0: The auxiliary resource is mounted to the primary resource.

  • 1: The auxiliary resource is bound to the primary resource.

  • 2: The auxiliary resource belongs to the primary resource.

region

String

Definition

ID of the region where the resource belongs.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 12 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

Enable pay-per-use billing for cloud WAF instance in the project with project ID project_id at Huawei Cloud International website.

POST https://{Endpoint}/v1/{project_id}/waf/postpaid?enterprise_project_id=0

{
  "console_area" : "hec-hk"
}

Example Responses

Status code: 200

OK

{
  "type" : 22,
  "resources" : [ {
    "resourceId" : "71f5de5f03414225b79be43ee3dc6bae",
    "cloudServiceType" : "hws.service.type.waf",
    "resourceType" : "hws.resource.type.waf.payperusedomain",
    "resourceSpecCode" : "waf.payperuse.domain",
    "resourceSize" : null,
    "expireTime" : null,
    "status" : 0
  }, {
    "resourceId" : "eb0760007a0b43fd9e445f5ce810f4c4",
    "cloudServiceType" : "hws.service.type.waf",
    "resourceType" : "hws.resource.type.waf.payperuserequest",
    "resourceSpecCode" : "waf.payperuse.request",
    "resourceSize" : null,
    "expireTime" : null,
    "status" : 0
  }, {
    "resourceId" : "6cae8a4d8074499d8c3bda687d63c4f9",
    "cloudServiceType" : "hws.service.type.waf",
    "resourceType" : "hws.resource.type.waf.payperuserule",
    "resourceSpecCode" : "waf.payperuse.rule",
    "resourceSize" : null,
    "expireTime" : null,
    "status" : 0
  } ],
  "isNewUser" : false
}

SDK Sample Code

The SDK sample code is as follows.

Enable pay-per-use billing for cloud WAF instance in the project with project ID project_id at Huawei Cloud International website.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class CreateCloudWafPostPaidResourceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCloudWafPostPaidResourceRequest request = new CreateCloudWafPostPaidResourceRequest();
        CreateCloudWafPostPaidResourceRequestbody body = new CreateCloudWafPostPaidResourceRequestbody();
        body.withConsoleArea("hec-hk");
        request.withBody(body);
        try {
            CreateCloudWafPostPaidResourceResponse response = client.createCloudWafPostPaidResource(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Enable pay-per-use billing for cloud WAF instance in the project with project ID project_id at Huawei Cloud International website.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateCloudWafPostPaidResourceRequest()
        request.body = CreateCloudWafPostPaidResourceRequestbody(
            console_area="hec-hk"
        )
        response = client.create_cloud_waf_post_paid_resource(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Enable pay-per-use billing for cloud WAF instance in the project with project ID project_id at Huawei Cloud International website.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

    request := &model.CreateCloudWafPostPaidResourceRequest{}
	request.Body = &model.CreateCloudWafPostPaidResourceRequestbody{
		ConsoleArea: "hec-hk",
	}
	response, err := client.CreateCloudWafPostPaidResource(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.