文档中心

域名注册

最近更新时间：2023.08.10 10:56:45

首次发布时间：2022.12.21 20:29:40

API 说明

API 名称：RegisterDomain。
API 域名：open.volcengineapi.com。
API 描述：注册一个域名。该操作会生成一个异步任务。您可以使用 GetAsyncTask 查询该任务的状态。

请求方法

POST

使用限制

节流限制：您每秒最多可以发送 50 个请求。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。

公共参数

在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下两个查询参数的取值说明如下：

参数名称	数据类型	是否必选	参数说明
Action	string	是	表示 API 的名称。该参数的取值是`RegisterDomain`。
Version	string	是	表示 API 的版本。该参数的取值是 `2022-12-12`。

请求参数

该 API 的请求参数的类型都是请求正文参数。

参数名称	数据类型	是否必选	参数说明	示例
domain	string	是	表示需要注册的域名。	`test.com`
template_tag	string	是	表示域名注册时使用的信息模板的 tag。您可以使用 ListTemplates 获取您需要使用的信息模板的 tag。您指定的信息模板必须是已实名认证的。不然，该 API 的调用会失败。要获取信息模板的实名认证状态，请留意 ListTemplates 返回的 `status` 参数的值，或者在域名服务控制台的信息模板页面查看。	`G0zM6RUUWLPysIuVPF7obA==`
period	int	否	表示域名的注册时长，单位是年。该参数的默认值是 `1`，最大值是 `10`。如果您指定了 `package_id`，您必须指定 `period = 1`。原因是在使用资源包注册域名时，您只能注册 1 年。	`2`
ns_list	[]string	否	表示域名的 NS 服务器列表。您需要指定 2 个 NS 服务器。如果您不指定该参数，火山引擎域名服务会为您的域名分配火山引擎的 NS 服务器。此时，该参数的值是 `["ns1.volcdns.com","ns2.volcdns.com"]`	`["ns1.volcdns.com","ns2.volcdns.com"]`
is_auto_renew	bool	否	表示是否对域名启用自动续费。该参数有以下取值： `true`：表示启用自动续费。启用自动续费后，如果域名的过期时间小于 15 天，火山引擎域名服务会自动为域名续费。 `false`：表示不启用自动续费。该参数的默认是 `false`。	`false`
package_id	string	否	表示域名特惠资源包的 ID。如果您已购买了资源包，可以使用资源包来抵扣您注册的域名。如果您要获取资源包的 ID，请打开火山引擎域名服务的特惠资源包页面。该参数的默认值是 `""`，表示不指定资源包。	`928affd2ae3821971`

响应正文

火山引擎域名服务在注册域名时，会对域名进行实名认证。域名的实名认证由各注册局审核，通常需要 1 个工作日，某些情况下可能需要 3-5 个工作日。

RegisterDomain 返回的是一个域名注册任务的 ID。您可以调用 GetAsyncTask 查询该任务的执行信息。

参数名称	数据类型	参数说明	示例
task_no	string	表示一个域名注册的异步任务的 ID。	`new-6023a78c90c878248`

请求示例

POST https://open.volcengineapi.com?Version=2022-12-12&Action=RegisterDomain
{
    "domain":"test.com",
    "template_tag": "G0zM6RUUWLPysIuVPF7obA=="
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201740440102120352201C78361C",
        "Action": "RegisterDomain",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "task_no": "new-6023a78c90c878248"
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见错误码。