CreatePrivateZone - 添加域名--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreatePrivateZone - 添加域名

最近更新时间：2025.06.23 20:22:16首次发布时间：2023.02.08 13:10:53

添加一个域名。

使用说明

请求频率：每秒最多调用 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	Array of String	否	["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]	域名所关联的一个或多个 VPC 的 TRN。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
Vpcs	Array of Object	是	无	与域名关联的一个或多个 VPC。域名解析在关联的 VPC 中生效。您需要关联至少一个 VPC。
RecursionMode	Boolean	否	false	是否开启递归解析。 true：开启递归解析。 false（默认）：不开启递归解析。
LineMode	Integer	否	0	是否开启负载均衡。 0（默认）：关闭负载均衡。 1：开启负载均衡。 2：该枚举值已废弃。 3：该枚举值已废弃。
Remark	String	否	remark	备注。默认为空字符串。
ClientToken	String	否	123456abcdef	用于确保请求的幂等性。如果您设置了该参数，在相同的请求参数下，无论该 API 被调用多少次，返回的结果都是相同的。该参数仅允许 ASCII 字符且不能超过 64 个字符。
Tags	Array of Object	否	无	域名所属的一个或多个标签。一个资源最多能关联 50 个标签。

返回参数

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

参数	类型	示例值	描述
ZID	Long	1013	标识域名的唯一 ID。

请求示例

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

{
    "ZoneName": "example.com",
    "RecursionMode": false,
    "Vpcs": [
      {
        "VpcId": "vpc-2d6si87atfh1c58ozfd0nzq8k",
        "Region": "cn-beijing"
      }
    "LineMode": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221214140553EC822FFD341E9C19EF59",
        "Action": "CreatePrivateZone",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "ZID": 1013
    }
}

错误码

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

状态码	错误码	错误信息	说明
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
409	ErrVPCUniqKey	zone already exists in vpc-1rff0ga2l8etc1nflydijknfz	VPC 已经存在关联的域名
500	ErrInternalServer	server internal error	服务内部错误