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

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreatePrivateZone-添加域名

最近更新时间：2024.08.23 11:25:07首次发布时间：2023.02.08 13:10:53

添加一个域名。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CreatePrivateZone`	API 的名称。该参数的取值是 `CreatePrivateZone`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

名称	类型	是否必选	示例值	描述
ZoneName	String	是	`example.com`	域名。可以是二级域名或多级域名。私网解析 PrivateZone 不支持以 `ivolces.com` 或 `privatelink.volces.com` 结尾的域名。
RecursionMode	Boolean	否	`true`	是否开启递归解析。 true：开启递归解析。 false（默认）：不开启递归解析。
VPCs	Object	是	`{"cn-beijing":["vpc-2d6si87atfh1c58ozfd0nzq8k"]}`	与域名关联的一个或多个 VPC。域名解析在关联的 VPC 中生效。您需要关联至少一个 VPC。
LineMode	Integer	否	`0`	是否开启智能解析和负载均衡。 0（默认）：关闭智能解析和负载均衡。 1：开启负载均衡，同时关闭智能解析。 2：关闭负载均衡，同时开启智能解析。 3：开启智能解析和负载均衡。
Remark	String	否	`Remark`	备注。默认为空字符串。

返回参数

ResponseMetadata 对象

参数	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

参数	类型	描述
ZID	Integer	标识域名的唯一 ID。

示例

请求示例

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

{
    "ZoneName": "internal003.com",
    "RecursionMode": false,
    "VPCs":{
        "cn-beijing":["vpc-2d6si87atfh1c58ozfd0nzq8k"]
        },
    "LineMode": 0
}

返回示例

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

错误码

您可访问公共错误码，获取详细信息。