API 说明

API 名称：GetDomain。

API 域名：domain-openapi.volcengineapi.com。

API 描述：获取指定域名的详细信息。

请求方法

GET

使用限制

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

请求鉴权

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

公共参数

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

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

请求参数

该 API 的请求参数的类型都是查询参数。

参数名称	数据类型	是否必选	参数说明	示例
domain	string	否	表示需要查询的域名。如果不指定该参数，您必须指定 instance_no。	test.com.cn
instance_no	string	否	表示该域名绑定的费用实例 ID。在火山引擎费用中心中，每个域名都绑定到一个费用实例 ID。您账单中显示的费用是归属到该费用实例的。您可以调用 ListDomains 获取每个域名绑定的费用实例 ID。如果不指定该参数，您必须指定 domain。	Domain7331695398481056041

返回参数

参数名称	数据类型	参数说明	示例
account_id	string	表示注册该域名的用户所归属的火山引擎主账号的 ID。	2100000001
address	string	表示域名所有者的英文地址。
address_zh	string	表示域名所有者的中文地址。
city	string	表示域名所有者所在城市的英文名称。	beijing
city_zh	string	表示域名所有者所在城市的中文名称。	北京
country_code	string	表示域名所有者所在国家的代码。	CN
created_at	int	表示该域名在火山引擎域名服务中创建的时间，格式是 Unix 时间戳。	1649515178
domain	string	表示查询的域名。	test.com.cn
domain_name_audit_status	string	表示域名的审核状态。该参数有以下取值： auditing：表示审核中。 audit_pass：表示审核通过。 audit_unPass：表示审核失败。	audit_pass
email	string	表示域名所有者的邮箱。	aaa@example.com
expired_time	int	表示该域名的过期时间，格式是 Unix 时间戳。	1820678400
instance_no	string	表示该域名绑定的费用实例 ID。	Domain7331695398481056041
is_auto_renew	bool	表示是否对域名启用自动续费。该参数有以下取值： true：表示启用自动续费。启用自动续费后，如果域名的过期时间小于 15 天，火山引擎域名服务会自动为域名续费。 false：表示不启用自动续费。	false
is_transfer_prohibited	bool	表示域名是否启用了禁止转移锁。该参数有以下取值： true: 表示启用了禁止转移锁。 false: 表示未启用禁止转移锁。	false
is_update_prohibited	bool	表示域名是否启用了禁止更新锁。该参数有以下取值： true: 表示启用了禁止更新锁。 false: 表示未启用禁止更新锁。	false
ns_list	string	表示域名的 NS 服务器列表。多个服务器之间以逗号（,）分隔。	ns1.volcengine-dns.com,ns2.volcengine-dns.com
post_code	string	表示域名所有者地址的邮编。	163000
register_time	int	表示域名的注册时间或者转入时间，格式是 Unix 时间戳。	1649433600
registrant	string	表示域名所有者的英文名。	Li Meng
registrant_fn	string	表示联系人的英文姓名中的名。	Meng
registrant_fn_zh	string	表示联系人中文姓名中的名。	萌
registrant_ln	string	表示联系人的英文姓名中的姓。	Li
registrant_ln_zh	string	表示联系人中文姓名的姓。	李
registrant_zh	string	表示域名所有者的中文名。	李萌
state	string	表示域名所有者所在的省份的英文名称。	heilongjiangsheng
state_zh	string	表示域名所有者的中文省份。	黑龙江省
status	string	表示域名的状态。该参数有以下取值： normal：表示域名正常。 registrant_change：表示域名正在过户中。 expired：表示域名已过期。 redemption：表示域名正处于赎回期。 wasted：表示您已不再拥有该域名。 transfer_out：表示域名曾经托管在火山引擎域名服务。但是当前已经转出了。 transferring：表示域名正处于账号间转移或者会员间 Push。 redeeming：表示域名正在赎回中。 registrant_changing：表示域名持有人信息正在更新。	normal
status_notice	string	表示域名状态的说明。一般在 status 不是 normal 的情况下会有状态说明。
template_tag	string	表示域名注册时使用的信息模板的 tag。	G0zM6RUUWLPysIuVPF7obA==
updated_at	int	表示该域名的最近一次更新时间，格式是 Unix 时间戳。更新操作包括变更自动续费的状态等。	1694486350
user_id	string	表示注册该域名的用户的 ID。	2100000001
verify_status	string	表示域名的实名认证的状态。该参数有以下取值： not_validation：表示域名还未进行实名认证。 pending_validation：表示实名认证正在进行中。 verification_success：表示域名已实名认证。 verification_failed：表示实名认证失败。	verification_success
zone	string	表示域名的 zone。	.com.cn

请求示例

响应示例

错误码

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

域名服务