DeletePrivateZone - 删除域名--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

DeletePrivateZone - 删除域名

最近更新时间：2025.05.22 19:25:53首次发布时间：2023.02.08 13:11:08

删除指定域名。

使用说明

请求频率：每秒最多调用 20 次。

请求说明

请求方式：POST
请求地址：https://private-zone.volcengineapi.com/?Action=DeletePrivateZone?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	DeletePrivateZone	要执行的操作，取值：DeletePrivateZone。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ZID	Long	是	1234	标识域名的唯一 ID。您可以通过以下 API 获取：添加域名 API 获取域名列表 API
DeleteWhenEmpty	Boolean	是	true	是否只能删除不包含解析记录的域名。 true：只能删除不包含解析记录的域名。 false（默认）：可以删除任何域名。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://private-zone.volcengineapi.com/?Action=DeletePrivateZone&Version=2022-06-01

{
    "ZID": 1013,
    "DeleteWhenEmpty": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202212141818173B434F9A79AC804BB175",
        "Action": "DeletePrivateZone",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrZoneNotFound	zone not found	未找到域名
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
500	ErrInternalServer	server internal error	服务内部错误
500	ErrZoneInternal	[Internal]zone error	内部错误