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	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 Enter 32 characters. Only letters and digits are allowed. 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 N/A Range N/A Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
console_area	Yes	String	Definition Site where the tenant is located. hec-hk: international site. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
type	Integer	Definition Cloud mode edition. Range -2: frozen -1: not subscribed 2: standard edition 3: professional edition 4: enterprise edition 7: starter edition 22: pay-per-use edition
resources	Array of ResourceResponse objects	The resource list.
isNewUser	Boolean	Definition Whether the user is a new user. Range N/A

**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

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

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

{
  "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
}