删除云模式防护域名
功能介绍
删除云模式防护域名
调用方法
请参见如何调用API。
URI
DELETE /v1/{project_id}/waf/instance/{instance_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
instance_id |
是 |
String |
参数解释: 域名id,您可以通过调用查询云模式防护域名列表(ListHost)获取域名id 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 域名id 取值范围: 不涉及 |
|
hostid |
String |
参数解释: 域名id 取值范围: 不涉及 |
|
description |
String |
参数解释: 描述信息 取值范围: 不涉及 |
|
type |
Integer |
参数解释: WAF部署模式,默认是1,目前仅支持反代模式 取值范围: 不涉及 |
|
proxy |
Boolean |
参数解释: 防护域名是否使用代理 取值范围: |
|
flag |
Flag object |
特殊标识,用于前端使用 |
|
hostname |
String |
参数解释: 云模式防护域名 取值范围: 不涉及 |
|
policyid |
String |
参数解释: 防护策略id 取值范围: 不涉及 |
|
timestamp |
Long |
参数解释: 创建防护域名的时间 取值范围: 13位毫秒时间戳 |
|
protect_status |
Integer |
参数解释: 域名防护状态 取值范围: |
|
access_status |
Integer |
参数解释: 域名接入状态 取值范围: |
|
access_code |
String |
参数解释: cname后缀 取值范围: 不涉及 |
|
exclusive_ip |
Boolean |
参数解释: 是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略 取值范围: |
|
paid_type |
String |
参数解释: 套餐付费模式,默认值为prePaid 取值范围: |
|
web_tag |
String |
参数解释: 网站名称,对应WAF控制台域名详情中的网站名称 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pci_3ds |
String |
参数解释: 是否开启pci_3ds合规认证 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
pci_dss |
String |
参数解释: 是否开启pci_dss合规认证 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
cname |
String |
参数解释: old:代表域名使用的老的cname,new:代表域名使用新的cname 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
is_dual_az |
String |
参数解释: 是否支持双AZ模式 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
ipv6 |
String |
参数解释: 域名是否开启ipv6 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
下游服务错误码 |
|
error_msg |
String |
下游服务报错信息 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
服务器内部错误 |
错误码
请参见错误码。