添加一个域名。

使用说明

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

请求说明

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：CreatePrivateZone

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

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

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

ProjectName string 可选示例值：default

域名所属项目的名称。默认为 default。

ZoneName string 必选示例值：example.com

域名。可以是二级域名或多级域名。私网解析 PrivateZone 不支持以 ivolces.com 或 privatelink.volces.com 结尾的域名。

VpcTrns string[] 可选示例值：["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]

域名所关联的一个或多个 VPC 的 TRN。格式为 trn:vpc:region:accountId:vpc/vpcId。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。

Vpcs object[] 可选示例值：```JSON "Vpcs": [ { "VpcId": "vpc-2d6si87atfh1c58ozfd******", "Region": "cn-beijing" } ]

域名关联的 VPC，只能关联当前账号的或跨账号授权的 VPC。新建时可以不关联 VPC。

VpcId string 必选示例值：vpc-3reow******hxad79k

VPC 的 ID。

Region string 必选示例值：cn-beijing

VPC 的地域。

RecursionMode boolean 可选示例值：false

是否开启递归解析。

true：开启递归解析。

false（默认）：不开启递归解析。

LineMode integer 可选示例值：0

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

支持取值：

0：关闭智能解析。

1：该参数已废弃。

2：该参数已废弃。

3：该参数已废弃。

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

Remark string 可选示例值：remark

备注。默认为空字符串。

ClientToken string 可选示例值：123456abcdef

用于确保请求的幂等性。如果您设置了该参数，在相同的请求参数下，无论该 API 被调用多少次，返回的结果都是相同的。该参数仅允许 ASCII 字符且不能超过 64 个字符。

Tags object[] 可选示例值：无

域名所属的一个或多个标签。一个资源最多能关联 50 个标签。

Key string 必选示例值：key

标签的键。

Value string 必选示例值：value

标签的值。

NodataFallback boolean 可选示例值：false

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

说明

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

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

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

返回参数

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

ZID long 示例值：1013

标识域名的唯一 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	ErrRegionNotSupport	%s of [%s] not supported by private_zone	private_zone不支持[%s]地域的%s
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrQuotaExceeded	[%s] exceeds quota [%d]	[%s] 超出限额 [%d]
400	ErrNoVPCSpecified	at least one vpc should be specified	未关联VPC
400	ErrVPCCountLimited	vpc count limited when binding zone	关联VPC数量超出限制
400	ErrIdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s)	幂等请求参数不一致
400	ErrIdempotentRequestInProgress	last idempotent request is in progress, please try later	上一次幂等请求还没结束，请稍后重试
400	ErrSubnetVPCBindLimit	zone in subnet mode should bind only one vpc	开启了智能解析的域名仅能关联一个 VPC
400	ErrParsingParams	parsing params error	参数错误
409	ErrVPCUniqKey	zone already exists in vpc-1rff0ga2l8etc1nflydijknfz	VPC 已经存在关联的域名
500	ErrInternalServer	server internal error	服务内部错误

TrafficRoute DNS 套件