API 名称：GetDomain。
API 域名：open.volcengineapi.com。
API 描述：获取指定域名的详细信息。
GET
节流限制：您每秒最多可以发送 50 个请求。
每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。
在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下两个查询参数的取值说明如下：
| 参数名称 | 数据类型 | 是否必选 | 参数说明 |
|---|---|---|---|
| Action | string | 是 | 表示 API 的名称。该参数的取值是GetDomain。 |
| Version | string | 是 | 表示 API 的版本。该参数的取值是 2022-12-12。 |
该 API 的请求参数的类型都是请求正文参数。
| 参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
domain | string | 否 | 表示需要查询的域名。 |
|
instance_no | string | 否 | 表示该域名绑定的费用实例 ID。 |
|
| 参数名称 | 数据类型 | 参数说明 | 示例 |
|---|---|---|---|
| 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 | 表示域名的审核状态。该参数有以下取值：
|
|
| string | 表示域名所有者的邮箱。 | aaa@example.com | |
| expired_time | int | 表示该域名的过期时间，格式是 Unix 时间戳。 | 1820678400 |
| instance_no | string | 表示该域名绑定的费用实例 ID。 | Domain7331695398481056041 |
is_auto_renew | bool | 表示是否对域名启用自动续费。该参数有以下取值：
|
|
is_transfer_prohibited | bool | 表示域名是否启用了禁止转移锁。该参数有以下取值：
|
|
is_update_prohibited | bool | 表示域名是否启用了禁止更新锁。该参数有以下取值：
|
|
| 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 | 表示域名的状态。该参数有以下取值：
|
|
| status_notice | string | 表示域名状态的说明。一般在 status 不是 normal 的情况下会有状态说明。 | |
| template_tag | string | 表示域名注册时使用的信息模板的 tag。 | G0zM6RUUWLPysIuVPF7obA== |
| updated_at | int | 表示该名的最近一次更新时间，格式是 Unix 时间戳。更新操作包括变更自动续费的状态等。 | 1694486350 |
| user_id | string | 表示注册该域名的用户的 ID。 | 2100000001 |
verify_status | string | 表示域名的实名认证的状态。该参数有以下取值：
|
|
| zone | string | 表示域名的 zone。 | .com.cn |
GET https://open.volcengineapi.com?Version=2022-12-12&Action=GetDomain&domain=test.com.cn
{ "ResponseMetadata": { "RequestId": "20230912143006C05223A3679723C560FA", "Action": "GetDomain", "Version": "2022-12-12", "Service": "domain_openapi", "Region": "cn-north-1" }, "Result": { "domain": "test.com.cn", "zone": ".com.cn", "template_tag": "uo7dqy0M6GL1tbgHJabskDg==", "ns_list": "ns1.volcengine-dns.com,ns2.volcengine-dns.com", "status": "normal", "verify_status": "verification_success", "domain_name_audit_status": "auditing", "status_notice": "", "is_update_prohibited": false, "is_transfer_prohibited": false, "is_auto_renew": true, "register_time": 1678327600, "expired_time": 1810000000, "instance_no": "Domain7331695398481056041", "user_id": "2100000001", "account_id": "2100000001", "country_code": "CN", "post_code": "100000", "email": "example@example.com", "registrant_fn": "San", "registrant_ln": "Zhang", "address": "Bei Jing Shi Hai Dian Qu", "city": "beijing", "state": "beijing", "registrant": "Bei Jing Ce Shi Gong Si", "registrant_fn_zh": "张三", "registrant_ln_zh": "张", "address_zh": "北京市海淀区", "city_zh": "北京", "state_zh": "北京", "registrant_zh": "测试公司", "created_at": 1678464277, "updated_at": 1681483255 } }
如果响应正文包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见 错误码。