Updated on 2024-04-25 GMT+08:00

Deleting a Dedicated WAF Instance

Function

This API is used to delete a dedicated WAF instance.

URI

DELETE /v1/{project_id}/premium-waf/instance/{instance_id}

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.

instance_id

Yes

String

ID of the dedicated WAF instance. It can be obtained by calling the WAF ListInstance API

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

ID of the dedicated WAF instance.

instancename

String

Name of the dedicated WAF instance.

region

String

ID of the region where the dedicated WAF instance is deployed.

zone

String

AZ ID

arch

String

CPU Architecture

cpu_flavor

String

ECS Specifications

vpc_id

String

ID of the VPC where the dedicated WAF instance locates.

subnet_id

String

ID of the VPC subnet where the dedicated WAF instance locates.

service_ip

String

Service plane IP address of the dedicated WAF instance.

security_group_ids

Array of strings

Security group where the dedicated WAF instance is added.

status

Integer

Billing status of the dedicated WAF instance.

  • 0: Normal.

  • 1: Frozen. Resources and data will be retained, but the instance cannot be used.

  • 2: Terminated. Resources and data will be cleared.

run_status

Integer

Running status of the dedicated instance. The value can be any of the following:

  • 0: Creating

  • 1: Running

  • 2: Deleting

  • 3: Deleted

  • 4: Creation failed

  • 5: Frozen

  • 6: Abnormal

  • 7: Updating

  • 8: Update failed

access_status

Integer

Access status of the dedicated engine. The value 0 indicates that the dedicated engine is not connected, and the value 1 indicates that the dedicated engine is connected.

upgradable

Integer

Whether the dedicated engine can be upgraded (0: no; 1: yes)

cloudServiceType

String

Cloud service code This parameter is used as an identifier only. You can ignore this parameter.

resourceType

String

Cloud service resource type, which is used as an identifier only. You can ignore this parameter.

resourceSpecCode

String

Cloud service resource code This parameter is used as an identifier only. You can ignore this parameter.

specification

String

Dedicated engine ECS specifications, for example, 8 vCPUs | 16 GB

serverId

String

ID of the ECS hosting the dedicated engine

create_time

Long

Time the dedicated WAF instance is created.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to delete a dedicated WAF instance in a project. The project ID is specified by project_id, and the instance ID is specified by instance_id.

DELETE https://{endpoint}z/v1/{project_id}/premium-waf/instance/{instance_id}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "0619871acb764d48a112695e8f7cbb10",
  "region" : "region-01-7",
  "zone" : "region-01-7a",
  "specification" : "8vCPUs | 16GB",
  "arch" : "x86",
  "upgradable" : 0,
  "status" : 0,
  "serverId" : "477353dc-8687-4bf4-b45b-1d7fee74fa63",
  "cloudServiceType" : "hws.service.type.waf",
  "resourceType" : "hws.resource.type.waf.instance",
  "resourceSpecCode" : "waf.instance.enterprise",
  "vpc_id" : "13718074-a3f9-408d-82aa-3c41ef55e589",
  "subnet_id" : "74d1b5a6-c7eb-4e9a-8372-181212552fcc",
  "service_ip" : "192.168.10.68",
  "security_group_ids" : [ "34287bdb-7aba-471a-b041-27427f1af76a" ],
  "cpu_flavor" : "Si2.2xlarge.2",
  "run_status" : 2,
  "access_status" : 1,
  "instancename" : "0412elb"
}

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.