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

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreateZone-添加域名

最近更新时间：2024.06.27 16:30:53首次发布时间：2022.11.24 20:57:30

添加一个域名。添加的域名不能是泛域名。在添加域名前，建议您调用 CheckZone API 检查您要添加的域名是否符合要求。

使用说明

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateZone?Version=2018-08-01

请求参数

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

Query

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

Body

名称	类型	是否必选	示例值	描述
ZoneName	String	是	`example.com`	添加的域名。域名必须是二级域名，并且不能是泛域名。
Remark	String	否	`Remark`	该域名的备注。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
CreatedAt	String	域名的创建时间。
UpdatedAt	String	域名的更新时间。
ZID	Integer	域名的 ID。
ZoneName	String	域名。
InstanceID	String	实例的 ID。对于云解析 DNS 免费版，该字段的值为 `null`。
Remark	String	域名的备注。
ConfigurationCode	String	该参数已弃用。
RecordCount	Integer	域名下的解析记录的总数。由于新添加的域名还未包含任何解析记录，所以该参数的值为 `0`。
ExpiredTime	Integer	域名的过期时间。当前该参数值为 `0`，表示域名不会过期。
LastOperator	String	创建该域名的用户的火山引擎账号的 ID。
CacheStage	Integer	域名所有权的状态。该参数有以下取值： `0`：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。 `1`：表示您不是域名的所有者。您添加此域名后，该域名的状态是 `域名待找回`。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
TradeCode	String	表示域名的功能版本。该参数有以下取值： `free_inner`：免费版。 `professional_inner`：专业版。 `enterprise_inner`：企业版。 `ultimate_inner`：旗舰版。 `ultimate_exclusive_inner`：尊享版。
DnsSecurity	String	DNS DDoS 防护服务的版本。 `dns_security_standard_inner`：安全防护标准版。 `""`：无安全防护版。
IsSubDomain	Boolean	是否是子域名。 `true`：子域名。 `false`：主域名。

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=CreateZone
{
  "Remark": "create a domain",
  "ZoneName": "test.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022110314022201020402601715A9DEBB",
        "Action": "CreateZone",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "CreatedAt": "2022-11-03T14:02:22+08:00",
        "UpdatedAt": "2022-11-03T14:02:22+08:00",
        "ZID": 2652,
        "ZoneName": "test.com",
        "InstanceID": null,
        "Remark": "create a domain",
        "ConfigurationCode": null,
        "RecordCount": 0,
        "ExpiredTime": 0,
        "LastOperator": "21xxxxx72",
        "CacheStage": 1,
        "TradeCode": "free_inner",
        "DnsSecurity": "",
        "IsSubDomain": false
    }
}

错误码

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