Deleting a Domain Name from the Cloud WAF
Function
This API is used to delete a domain name from the cloud WAF.
Calling Method
For details, see Calling APIs.
URI
DELETE /v1/{project_id}/waf/instance/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range Enter 32 characters. Only letters and digits are allowed. Default Value N/A |
instance_id |
Yes |
String |
Definition Domain name ID. You can call the ListHost API to obtain the domain name ID. Constraints N/A Range Enter 32 characters. Only letters and digits are allowed. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range
Default Value 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Domain name ID. Range N/A |
hostid |
String |
Definition Domain name ID. Range N/A |
description |
String |
Definition Description. Range N/A |
type |
Integer |
Definition WAF deployment mode. The default value is 1. Currently, only the reverse proxy is supported. Range N/A |
proxy |
Boolean |
Definition Whether the protected domain name uses a proxy. Range
|
flag |
Flag object |
Special identifier, which is used on the console. |
hostname |
String |
Definition Domain Names Protected in Cloud Mode Range N/A |
policyid |
String |
Definition Protection policy ID. Range N/A |
timestamp |
Long |
Definition Time a domain name is added to WAF. Range 13-bit millisecond timestamp. |
protect_status |
Integer |
Definition Domain protection status. Range
|
access_status |
Integer |
Definition Domain name access status. Range
|
exclusive_ip |
Boolean |
Definition Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored. Range
|
paid_type |
String |
Definition Package payment mode. The default value is prePaid. Range
|
web_tag |
String |
Definition Website name, which is the website name displayed on the domain name details page on the WAF console. Range N/A |
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Definition Whether to enable PCI 3DS compliance authentication. Constraints N/A Range
Default Value N/A |
pci_dss |
String |
Definition Whether to enable PCI_DSS compliance authentication. Constraints N/A Range
Default Value N/A |
cname |
String |
Definition old: The old CNAME record is used. new: new CNAME record is used. Constraints N/A Range
Default Value N/A |
is_dual_az |
String |
Definition Whether the dual-AZ mode is supported Constraints N/A Range
Default Value N/A |
ipv6 |
String |
Definition Whether IPv6 is enabled for the domain name. Constraints N/A Range
Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
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.
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