You need to enable JavaScript to run this app.
导航
添加域名
最近更新时间:2023.12.06 10:39:29首次发布时间:2022.11.24 20:57:30

API 说明

API 名称:CreateZone
API 域名:open.volcengineapi.com
API 描述:添加一个域名。添加的域名不能是泛域名。在添加域名前,建议您调用 CheckZone API 检查您要添加的域名是否符合要求。

请求方法

POST

调用限制

每秒最多调用 5 次。

请求参数

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

参数名称数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 CreateZone
VersionString查询参数API 的版本。该参数的取值是 2018-08-01

ZoneName

String

请求正文参数

添加的域名。域名必须是二级域名,并且不能是泛域名。

RemarkString请求正文参数该域名的备注。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型参数说明
CreatedAtString域名的创建时间。
UpdatedAtString域名的更新时间。
ZIDInteger域名的 ID。
ZoneNameString域名。
InstanceIDString实例的 ID。对于云解析 DNS 免费版,该字段的值为 null
RemarkString域名的备注。
ConfigurationCodeString该参数已弃用。
RecordCountInteger域名下的解析记录的总数。由于新添加的域名还未包含任何解析记录,所以该参数的值为 0
ExpiredTimeInteger域名的过期时间。当前该参数值为 0,表示域名不会过期。
LastOperatorString创建该域名的用户的火山引擎账号的 ID。

CacheStage

Integer

域名所有权的状态。该参数有以下取值:

  • 0:表示您是域名的所有者。在您添加此域名后,就可以管理域名解析了。

  • 1:表示您不是域名的所有者。在您添加此域名后,该域名的状态是 域名待找回。如果您要管理域名解析,您需要在控制台根据提示验证您的域名所有权。

TradeCode

String

表示域名的功能版本。该参数有以下取值:

  • free_inner:免费版。

  • professional_inner:专业版。

  • enterprise_inner:企业版。

  • ultimate_inner:旗舰版。

  • ultimate_exclusive_inner:尊享版。

DnsSecurityStringDNS DDoS 防护服务的版本。
  • dns_security_standard_inner:安全防护标准版。
  • "":无安全防护版。

示例

请求示例

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