Updated on 2024-03-06 GMT+08:00

Deleting a Domain Name from the Cloud WAF

Function

This API is used to delete a domain name from the cloud WAF.

URI

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

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.

instance_id

Yes

String

Domain name ID. It can be obtained by calling the ListHost API.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostid

String

Domain name ID

description

String

Description.

type

Integer

WAF deployment mode. The default value is 1. Currently, only the reverse proxy is supported.

proxy

Boolean

Whether a proxy is used for the protected domain name.

  • false: No proxy is used.

  • true: A proxy is used.

flag

Flag object

Special identifier, which is used on the console.

hostname

String

Domain name added to cloud WAF.

access_code

String

CNAME suffix

policyid

String

Policy ID

timestamp

Long

Time the domain name was added to WAF.

protect_status

Integer

WAF status of the protected domain name.

  • -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

access_status

Integer

Access status.

  • 0: The website traffic has not been routed to WAF. (Inaccessible)

  • 1: The website traffic has been routed to WAF. (Accessible)

exclusive_ip

Boolean

Whether to use a dedicated IP address. This parameter is reserved and can be ignored.

  • true: Use a dedicated IP address.

  • false: Do not use a dedicated IP address.

paid_type

String

Package billing mode. The value can be prePaid or postPaid. prePaid is for yearly/monthly billing. postPaid is for pay-per-use billing. Default value: prePaid.

web_tag

String

Website name

Table 5 Flag

Parameter

Type

Description

pci_3ds

String

Whether the website passes the PCI 3DS certification check.

  • true: The website passed the PCI 3DS certification check.

  • false: The website failed the PCI 3DS certification check.

Enumeration values:

  • true

  • false

pci_dss

String

Whether the website passed the PCI DSS certification check.

  • true: The website passed the PCI DSS certification check.

  • false: The website failed the PCI DSS certification check.

Enumeration values:

  • true

  • false

cname

String

The CNAME record being used.

  • old: The old CNAME record is used.

  • new: The new CNAME record is used.

Enumeration values:

  • old

  • new

is_dual_az

String

Whether WAF support Multi-AZ DR

  • true: WAF supports multi-AZ DR.

  • false: WAF does not support multi-AZ DR.

Enumeration values:

  • true

  • false

ipv6

String

Whether IPv6 protection is supported.

  • true: IPv6 protection is supported.

  • false: IPv6 protection is not supported.

Enumeration values:

  • true

  • false

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

DELETE https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}?enterprise_project_id=0

The following shows how to delete domain names protected with cloud WAF in a specific project. The project ID is specified by project_id, and the domain ID is specified by instance_id.

Example Responses

Status code: 200

OK

{
  "id" : "e91ad96e379b4bea84f8fcda3d153370",
  "hostid" : "e91ad96e379b4bea84f8fcda3d153370",
  "description" : "",
  "type" : 1,
  "proxy" : true,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "true",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "region" : "cn-north-4",
  "hostname" : "www.demo.com",
  "access_code" : "4f5372610cdc44f7970759fcca138c81",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "timestamp" : 1650423573650,
  "protect_status" : 1,
  "access_status" : 0,
  "exclusive_ip" : false,
  "web_tag" : "we",
  "paid_type" : "prePaid"
}

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.