Help Center/ Web Application Firewall/ API Reference/ APIs/ Dedicated Instance Management/ Creating a Dedicated WAF Instance
Updated on 2024-04-25 GMT+08:00
View PDF

Creating a Dedicated WAF Instance

Function

This API is used to create a dedicated WAF instance.

URI

POST /v1/{project_id}/premium-waf/instance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to 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

ID of the enterprise project. It can be obtained 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

chargemode

No

Integer

Billing mode. Currently, only pay-per-use (30) is supported.

region

Yes

String

Region where a dedicated engine is to be created.

available_zone

Yes

String

AZ where the dedicated engine is to be created.

arch

Yes

String

CPU architecture of the dedicated WAF instance, supporting only x86

instancename

Yes

String

Prefix of dedicated WAF engine names

specification

Yes

String

Specifications of the dedicated WAF instance

  • waf.instance.enterprise: the enterprise edition, corresponding to WI-500 on the console.

  • waf.instance.enterprise: the professional edition, corresponding to WI-100 on the console.

cpu_flavor

No

String

Flavor of the ECS used for the dedicated WAF instance. This parameter is optional when you create the WAF instances of the network interface type. This parameter is mandatory when you create the WAF instances of the ECS type. For WAF instances of the ECS type, select a flavor based on what are available on the console.

vpc_id

Yes

String

ID of the VPC where the dedicated engine is located.

subnet_id

Yes

String

ID of the VPC subnet where the dedicated engine is located.

security_group

Yes

Array of strings

ID of the security group where the dedicated engine is located.

count

Yes

Integer

Number of dedicated WAF instance applied for

res_tenant

No

Boolean

Whether this is resource tenant. The default value is false.

  • false: common tenant.

  • true: resource tenant.

anti_affinity

No

Boolean

Whether to enable anti-affinity. Only the WAF instances of the network interface type support this feature.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

instances

Array of instanceInfo objects

instances
Table 6 instanceInfo

Parameter

Type

Description

id

String

ID of the dedicated WAF instance.

name

String

Name of the dedicated WAF instance.

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 create a WAF dedicated instance. The project ID is specified by project_id. Billing mode: pay-per-use. Region: region-01-4. AZ: region-01-4a. CPU architecture: x86. Prefix of the instance name: demo. Edition: Enterprise. VPC ID: d7b6a5ff-6c53-4cd4-9d57-f20ee8753056. Subnet ID: e59ccd18-7e15-4588-b689-04b856f4e78b. Security group ID: 09b156a2-f0f0-41fd-9891-60e594601cfd. Quantity: one. Instance type: ECS.

POST https://{endpoint}/v1/{project_id}/premium-waf/instance

{
  "chargemode" : 30,
  "region" : "region-01-4",
  "available_zone" : "region-01-4a",
  "arch" : "x86",
  "instancename" : "demo",
  "specification" : "waf.instance.enterprise",
  "vpc_id" : "d7b6a5ff-6c53-4cd4-9d57-f20ee8753056",
  "subnet_id" : "e59ccd18-7e15-4588-b689-04b856f4e78b",
  "security_group" : [ "09b156a2-f0f0-41fd-9891-60e594601cfd" ],
  "count" : 1,
  "res_tenant" : true
}

Example Responses

Status code: 200

Dedicated WAF instance information

{
  "instances" : [ {
    "id" : "50a6b6c9bdb643f9a8038976fc58ad02",
    "name" : "demo-6wvl"
  } ]
}

Status Codes

Status Code

Description

200

Dedicated WAF instance information

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.