域名询价--域名服务-火山引擎

文档中心

立即注册

导航

域名询价

最近更新时间：2024.04.02 15:28:31首次发布时间：2022.12.21 20:29:40

API 说明

API 名称：CheckFee。
API 域名：open.volcengineapi.com。
API 描述：查询域名价格，能否注册以及是否包含限制词等信息。

请求方法

GET

使用限制

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

请求鉴权

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

公共参数

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

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

请求参数

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

参数名称	数据类型	是否必选	参数说明	示例
domain	string	是	表示需要询价的一个二级域名。域名可以是中文域名，也可以是英文域名。	`test.com`

响应正文

参数名称	数据类型	参数说明	示例
domain	string	表示询价的域名。	`test.com`
zone	string	表示该域名的顶级域。	`.com`
status	string	表示域名的注册状态。该参数有以下取值： `0`：表示域名不可注册。 `1`：表示域名可注册。 `2`：表示询价超时。 `3`：表示不支持注册该后缀的域名。	`1`
is_limit_domain	bool	表示域名是否包含国家法律规定的限制词。该参数有以下取值： `true`：表示包含限制词。 `false`：表示不包含限制词。如果该参数值是 `true`，域名仍然是可以注册的，但是可能无法通过命名审核。	`true`
new_price	string	表示域名第一年的注册费用。	`56`
renew_price	string	表示域名的续费价格。如果 `status = 0`，该参数值无效。	`80`
restore_price	string	表示域名的赎回价格。如果 `status = 0`，该参数值无效。	`80`
domain_type	string	表示域名的类型。该参数有以下取值： `G`：表示中文域名。 `E`：表示英文域名。	`E`
price_type	string	表示域名的类型。该参数有以下取值： `0`：表示普通域名。 `1`：表示白金域名。 `2`：表示一口价域名。	`0`
notice_info	string	表示该接口返回的提示信息。例如请求超时，域名后缀不支持等。	`暂不支持该后缀`

请求示例

GET https://open.volcengineapi.com?Version=2022-12-12&Action=CheckFee&domain=test123456.com

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201528390102080370802573E9D4",
        "Action": "CheckFee",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "domain": "test123456.com",
        "zone": ".com",
        "status": "0",
        "is_limit_domain": false,
        "new_price": "",
        "renew_price": "69",
        "restore_price": "836",
        "domain_type": "E",
        "price_type": "0",
        "notice_info": ""
    }
}

错误码

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