Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Your Subscriptions/ Changing specifications of a cloud WAF instance billed yearly/monthly.
Updated on 2024-04-25 GMT+08:00
View PDF

Changing specifications of a cloud WAF instance billed yearly/monthly.

Function

This API is used to change specifications of a cloud WAF instance that is billed yearly/monthly. Notes:

  • 1: The cloud WAF instance must be billed yearly/monthly.

  • 2: The edition for the WAF instance cannot be scaled down. The number of any type of expansion packages cannot be decreased to 0.

  • 3: The number of each type of expansion packages can only be increased or decreased together.

Constraints

If the payment fails, the system automatically generates a pending payment order. You can select another payment method on the console.

URI

POST /v1/{project_id}/waf/subscription/batchalter/prepaid-cloud-waf

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain the value, go to the Cloud management console first. Then, click your username, select My Credentials, and view the Project ID column in the Projects area.
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.

Default: application/json;charset=utf8
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

is_auto_pay

Yes

Boolean

Whether automatic payment is enabled.

  • false: Automatic payment is not enabled. You need to complete payment manually.

  • **: Automatic payment is enabled.

waf_product_info

No

AlterWafProductInfo object

Changing the WAF edition.

domain_expack_product_info

No

ExpackProductInfo object

Changing the quantity of domain name expansion packages

bandwidth_expack_product_info

No

ExpackProductInfo object

Changing the quantity of bandwidth name expansion packages

rule_expack_product_info

No

ExpackProductInfo object

Changing the quantity of rule name expansion packages
Table 5 AlterWafProductInfo

Parameter

Mandatory

Type

Description

resource_spec_code

No

String

WAF editions

  • detection: The Starter edition.

  • professional: The Standard edition.

  • enterprise: The Professional edition.

  • ultimate: The Platinum edition.
Table 6 ExpackProductInfo

Parameter

Mandatory

Type

Description

resource_size

No

Integer

Number of expansion packages

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

orderId

String

Order ID.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to change the yearly/monthly cloud WAF specifications. Project ID: 550500b49078408682d0d4f7d923f3e1. Auto-renewal: changed to enabled. Quantity of bandwidth expansion packages: changed to 2.

POST https://{Endpoint}/v1/{project_id}/waf/subscription/batchalter/prepaid-cloud-waf?enterprise_project_id=0

{
  "project_id" : "550500b49078408682d0d4f7d923f3e1",
  "is_auto_pay" : true,
  "domain_expack_product_info" : {
    "resource_size" : 2
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "orderId" : "38ff0cb9a10e4d5293c642bc0350fa6d"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.