You need to enable JavaScript to run this app.
导航
CreatePrivateZone-添加域名
最近更新时间:2024.12.10 10:36:27首次发布时间: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.comprivatelink.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
备注。默认为空字符串。
ClientToken
String
123456abcdef
用于确保请求的幂等性。如果您设置了该参数,在相同的请求参数下,无论该 API 被调用多少次,返回的结果都是相同的。该参数仅允许 ASCII 字符且不能超过 64 个字符。
ProjectName
String
default
域名所属项目的名称。默认为 default
VpcTrns
Array of strings
["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]
域名所关联的一个或多个 VPC 的 TRN。格式为 trn:vpc:region:accountId:vpc/vpcId。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限,您需要传入该参数。
Tags
Array of objects
[{"Key":"key1", "Value":"value1"},{"Key":"key2", "Value":"value2"}]
域名所属的一个或多个标签。一个资源最多能关联 50 个标签。

返回参数

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
    }
}

错误码

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