文档中心

获取域名列表

最近更新时间：2024.01.30 20:45:11

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

API 说明

API 名称：ListDomains。
API 域名：open.volcengineapi.com。
API 描述：查询您在火山引擎域名服务托管的域名的详细信息。

请求方法

GET

使用限制

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

请求鉴权

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

公共参数

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

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

请求参数

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

参数名称	数据类型	是否必选	参数说明	示例
domain	string	否	查询指定域名的详细信息。如果不指定该参数，则查询所有域名。	`test.com`
domain_name_audit_status	string	否	指定一个或多个命名审核状态，查询处于该状态的域名。多个状态使用逗号（,）分隔。该参数有以下取值： `auditing`：表示审核中。 `audit_pass`：表示审核通过。 `audit_unPass`：表示审核失败。如果不指定该参数，则不使用审核状态对查询结果进行过滤。	`audit_pass,auditing`
expired_after	int	否	查询将在指定天数后过期的域名。如果不指定该参数，则不使用过期时间对查询结果进行过滤。	`3`
is_auto_renew	bool	否	查询指定自动续费状态的域名。该参数有以下取值： `true`：表示自动续费已开启。 `false`：表示自动续费未开启。如果不指定该参数，则不使用自动续费状态对查询结果进行过滤。	`false`
order_by	string	否	表示按指定的字段对域名列表进行排序。您可以指定以下字段： `register_time`：表示域名的注册时间。 `expired_time`：表示域名的过期时间。该参数的默认值是 `register_time`。	`register_time`
asc_or_desc	string	否	表示如何对查询结果进行排序。该参数有以下取值： `ASC`：表示升序。 `DESC`：表示降序。该参数的默认是 `DESC`。	`ASC`
page_number	int	否	表示页码。该 API 返回该页码所包含的域名。该参数的默认值是 `1`。	`1`
page_size	int	否	表示每页包含的域名数量。系统会将获取的域名进行分页显示。页数是由获取的域名总数和 `page_size` 确定。该参数的默认值是 `10`，最大值是 `50`。	`10`
status	string	否	指定一个或者多个状态，查询处于该状态的域名。多个状态使用逗号（,）分隔。该参数有以下取值： `normal`：表示域名正常。 `registrant_change`：表示域名正在过户中。 `expired`：表示域名已过期。 `redemption`：表示域名正处于赎回期。 `wasted`：表示您已不再拥有该域名。 `transfer_out`：表示域名曾经托管在火山引擎域名服务。但是当前已经转出了。 `transferring`：表示域名正处于账号间转移或者会员间 Push。 `redeeming`：表示域名正在赎回中。 `registrant_changing`：表示域名持有人信息正在更新。如果不指定该参数，则不使用域名状态对查询结果进行过滤。	`normal,redeeming`
verify_status	string	否	指定一个或者多个实名认证状态，查询处于该状态的域名。多个状态使用逗号（,）分隔。该参数有以下取值： `not_validation`：表示域名还未进行实名认证。 `pending_validation`：表示实名认证正在进行中。 `verification_success`：表示域名已实名认证。 `verification_failed`：表示实名认证失败。您可以指定一个或者多个参数值。多个参数值使用逗号（,）分隔。如果不指定该参数，则不使用实名认证状态对查询结果进行过滤。	`verification_success,pending_validation`

响应正文

参数名称	数据类型	参数说明	示例
domain_info_list	array	表示一个域名列表。
--- domain	string	表示一个域名。	`test.com`
--- zone	string	表示域名的顶级域。	`.com`
--- template_tag	string	表示该域名在注册或转入时所使用的信息模板的 tag。	`G0zM6RUUWLPysIuVPF7obA==`
--- ns_list	string	表示该域名的 NS 服务器列表。	`ns1.volcdns.com,ns2.volcdns.com`
--- status	string	表示域名的状态。该参数有以下取值： `normal`：表示域名正常。 `registrant_change`：表示域名正在过户中。 `expired`：表示域名已过期。 `redemption`：表示域名正处于赎回期。 `wasted`：表示您已不再拥有该域名。 `transfer_out`：表示域名曾经托管在火山引擎域名服务。但是当前已经转出了。 `redeeming`：表示域名正在赎回中。 `registrant_changing`：表示域名持有人信息正在更新。	`normal`
--- verify_status	string	表示域名的实名认证状态。该参数有以下取值： `not_validation`：表示域名还未进行实名认证。 `pending_validation`：表示实名认证正在进行中。 `verification_success`：表示域名已实名认证。 `verification_failed`：表示实名认证失败。	`verification_success`
--- domain_name_audit_status	string	表示域名的审核状态。该参数有以下取值： `auditing`：表示审核中。 `audit_pass`：表示审核通过。 `audit_unPass`：表示审核失败。	`audit_pass`
--- status_notice	string	表示域名状态的说明。一般在 `status` 不是 `normal` 的情况下会有状态说明。	`""`
--- is_update_prohibited	bool	表示该域名是否启用了禁止更新锁。该参数有以下取值： `true`：表示域名启用了禁止更新锁。此时，您无法修改域名的 NS 服务器。 `false`：表示域名未启用禁止更新锁。	`false`
--- is_transfer_prohibited	bool	表示该域名是否启用了禁止转移锁。该参数有以下取值： `true`：表示域名启用了禁止转移锁。此时，您无法从火山引擎域名服务中转出该域名。 `false`：表示域名未启用禁止转移锁。	`false`
--- is_auto_renew	bool	表示该域名是否启用了自动续费。该参数有以下取值： `true`：表示域名启用了自动续费。 `false`：表示域名未启用自动续费。	`true`
--- register_time	int	表示该域名的注册时间或者转入时间。格式是 Unix 时间戳。	`1649433600`
--- expired_time	int	表示该域名的过期时间。格式是 Unix 时间戳。	`1680969600`
--- user_id	string	表示注册该域名的用户的 ID。	`2100029272`
--- account_id	string	表示注册该域名的用户所归属的火山引擎主账号的 ID。	`2100029272`
--- created_at	int	表示该域名记录在火山引擎域名服务中创建的时间。格式是 Unix 时间戳。	`1649515178`
--- updated_at	int	表示该域名的最近一次更新时间。格式是 Unix 时间戳。更新操作包括变更自动续费的状态等。	`1662031672`
total	int	表示获取到的域名数量。	`2`

请求示例

GET https://open.volcengineapi.com?Version=2022-12-12&Action=ListDomains&status=normal

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201503310102121720470D75925D",
        "Action": "ListDomains",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "domain_info_list": [
            {
                "domain": "test.top",
                "zone": ".top",
                "template_tag": "G0zM6RUUWLPysIuVPF7obA==",
                "ns_list": "ns1.volcdns.com,ns2.volcdns.com",
                "status": "normal",
                "verify_status": "verification_success",
                "domain_name_audit_status": "audit_pass",
                "status_notice": "",
                "is_update_prohibited": false,
                "is_transfer_prohibited": false,
                "is_auto_renew": false,
                "register_time": 1649433600,
                "expired_time": 1680969600,
                "user_id": "2100089272",
                "account_id": "2100089272",
                "created_at": 1649515178,
                "updated_at": 1662031672
            },
            {
                "domain": "example.life",
                "zone": ".life",
                "template_tag": "G8zM6SUUWLPysIuVPF7abA==",
                "ns_list": "ns1.volcdns.com,ns2.volcdns.com",
                "status": "normal",
                "verify_status": "verification_success",
                "domain_name_audit_status": "audit_pass",
                "status_notice": "",
                "is_update_prohibited": false,
                "is_transfer_prohibited": false,
                "is_auto_renew": false,
                "register_time": 1643126400,
                "expired_time": 1674662400,
                "user_id": "2100089272",
                "account_id": "2100089272",
                "created_at": 1643207511,
                "updated_at": 1667217228
            }
        ],
        "total": 2
    }
}

错误码

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