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}
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 |
Domain name ID. It can be obtained by calling the ListHost API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request 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
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.
|
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.
|
access_status |
Integer |
Access status.
|
exclusive_ip |
Boolean |
Whether to use a dedicated IP address. This parameter is reserved and can be ignored.
|
paid_type |
String |
Package-based payment mode. Enumeration values:
|
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Whether the website passes the PCI 3DS certification check.
Enumeration values:
|
pci_dss |
String |
Whether the website passed the PCI DSS certification check.
Enumeration values:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
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
Example Responses
Status code: 200
OK
{ "id" : "e91ad96e379b4bea84f8fcda3d153370", "hostid" : "e91ad96e379b4bea84f8fcda3d153370", "type" : 1, "proxy" : true, "flag" : { "pci_3ds" : "false", "pci_dss" : "false", "cname" : "new" }, "hostname" : "www.demo.com", "access_code" : "4f5372610cdc44f7970759fcca138c81", "policyid" : "f385eceedf7c4c34a4d1def19eafbe85", "timestamp" : 1650423573650, "protect_status" : 1, "access_status" : 0, "exclusive_ip" : false, "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot