文档首页/ Web应用防火墙 WAF/ API参考/ API/ 云模式防护网站管理/ 删除云模式防护域名
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除云模式防护域名

功能介绍

删除云模式防护域名

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

instance_id

是

String

域名id，您可以通过调用查询云模式防护域名列表（ListHost）获取域名id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

是

String

内容类型

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

域名id

hostid

String

域名id

description

String

描述信息

type

Integer

WAF部署模式，默认是1，目前仅支持反代模式

proxy

Boolean

防护域名是否使用代理

  • false：不使用代理

  • true：使用代理

flag

Flag object

特殊标识，用于前端使用

hostname

String

创建的云模式防护域名

access_code

String

cname后缀

policyid

String

策略id

timestamp

Long

创建防护域名的时间

protect_status

Integer

域名防护状态：

  • -1：bypass，该域名的请求直接到达其后端服务器，不再经过WAF

  • 0：暂停防护，WAF只转发该域名的请求，不做攻击检测

  • 1：开启防护，WAF根据您配置的策略进行攻击检测

access_status

Integer

接入状态，0： 未接入，1：已接入

exclusive_ip

Boolean

是否使用用户独享的引擎公网ip，该参数为预留参数，用于后续功能扩展，用户可忽略

  • true：使用独享ip

  • false：不使用独享ip

paid_type

String

套餐付费模式，默认值为prePaid。prePaid：包周期款模式；postPaid：按需模式。

web_tag

String

网站名称，对应WAF控制台域名详情中的网站名称
表5 Flag

参数

参数类型

描述

pci_3ds

String

是否开启pci_3ds合规认证

  • true：开启

  • false：不开启

pci_dss

String

是否开启pci_dss合规认证

  • true：开启

  • false：不开启

cname

String

old：代表域名使用的老的cname，new：代表域名使用新的cname

is_dual_az

String

是否支持双AZ模式

  • true：支持

  • false：不支持

ipv6

String

域名是否开启ipv6

  • true：支持

  • false：不支持

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

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

删除项目id为project_id，域名id的为instance_id的云模式域名。

响应示例

状态码： 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"
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 云模式防护网站管理

相关文档