Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Your Subscriptions/ Enabling Pay-Per-Use Billing for Cloud WAF
Updated on 2024-07-02 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.

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

Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Content-Type

Yes

String

Content type.

region

Yes

String

Region ID.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

console_area

Yes

String

Website the account belongs to. The value is hec-hk for Huawei Cloud International website.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

type

Integer

The edition for the cloud WAF instance.

  • -2: Frozen.

  • 1: Not subscribed.

  • 2: The Standard edition.

  • 3: The Professional edition.

  • 4: The Platinum edition.

  • 7: The Starter edition.

  • 22: The pay-per-use edition.

resources

Array of ResourceResponse objects

The resource list.

isNewUser

Boolean

New user or not.

Table 6 ResourceResponse

Parameter

Type

Description

resourceId

String

Resource ID.

cloudServiceType

String

Cloud service type.

resourceType

String

Cloud service resource type.

  • 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.domain: bandwidth expansion packages in yearly/monthly cloud-mode WAF

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

  • hws.resource.type.waf.instance: dedicated WAF instances

  • 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

Cloud resource specifications.

status

Integer

Resource status. The value can be:

  • 0: Unfrozen/Normal.

  • 1: Frozen.

  • 2: Deleted.

expireTime

String

Resource expiration time.

resourceSize

Integer

Resource quantity.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

The following example shows how to enable pay-per-use billing for cloud WAF in a specific project. The project ID is specified by project_id. The site is 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
}

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.