更新指定域名的配置。

使用说明

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

请求说明

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：UpdatePrivateZone

要执行的操作，取值：UpdatePrivateZone。

Version string 必选示例值：2022-06-01

API的版本，取值：2022-06-01。

LineMode integer 可选示例值：4

是否开启智能解析。打开后不可再关闭。

支持取值：

0：关闭智能解析。

1：该参数已废弃。

2：该参数已废弃。

3：该参数已废弃。

4：开启智能解析。打开智能解析后，支持根据不同请求来源或者权重返回解析记录值，打开后不可再关闭。

ZID long 必选示例值：1234

标识域名的唯一 ID。您可以通过以下 API 获取：

添加域名 API

获取域名列表 API

RecursionMode boolean 可选示例值：true

开启或关闭递归解析。

true：开启递归解析。

false：不开启递归解析。

如果您不设置该参数，该参数的值不会变化。

LoadBalance boolean 可选示例值：-

该字段已废弃。

Remark string 可选示例值：remark

备注。如果您不设置该参数，该参数的值不会变化。

NodataFallback boolean 可选示例值：false

针对私网域名在解析状态码为 NOERROR 且本地解析为空的场景，是否回退到公网递归解析。

说明

只有开启递归解析开关时（RecursionMode = true），该参数才生效。

true：当该私网域名及其子域名的解析状态码为 NOERROR 且本地解析返回为空时，触发公网递归解析规则，由公网递归 DNS 服务器返回查询结果。

false：（默认）上述场景下不触发公网递归解析，直接返回空结果。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

ZID long 示例值：1234

标识域名的唯一 ID。

NodataFallback boolean 示例值：false

针对私网域名在解析状态码为noerror且本地解析为空的情况下出公网递归解析；需要先打开递归开关才有效

ZoneName string 示例值：example.com

域名。

Remark string 示例值：remark

域名备注。

RecursionMode boolean 示例值：true

域名是否开启了递归解析。

true：域名开启了递归解析。

false：域名未开启递归解析。

LineMode integer 示例值：0

是否开启负载均衡。

0：关闭负载均衡。

1：开启负载均衡。

2：该参数已废弃。

3：该参数已废弃。

RecordCount integer 示例值：10

解析记录的数量。

Region string[] 示例值：[ "华北2（北京）|cn-beijing" ]

VPC 所在的地域。

CreatedAt string 示例值：2022-12-14T14:05:53+08:00

域名的创建时间。

UpdatedAt string 示例值：2022-12-14T15:29:41+08:00

域名的更新时间。

LastOperator string 示例值：2100054541

表示添加该域名的火山引擎账号的 ID。

ProjectName string 示例值：default

域名所属项目。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrQuotaExceeded	[%s] exceeds quota [%d]	[%s] 超出限额 [%d]
400	ErrChangeLineMode	LineMode is not allowed to change	不能变更 LineMode 参数
500	ErrInternalServer	server internal error	服务内部错误
500	ErrZoneInternal	[Internal]zone error	内部错误

TrafficRoute DNS 套件