QueryZone - 获取域名详细信息--TrafficRoute DNS 套件-火山引擎

文档中心

TrafficRoute DNS 套件

域名管理

QueryZone - 获取域名详细信息

获取一个域名的详细信息。

使用说明

请求频率：每秒最多调用 20 次。

请求说明

请求方式：GET
请求地址：https://dns.volcengineapi.com/?Action=QueryZone&Version=2018-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	QueryZone	要执行的操作，取值：QueryZone。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZID	Long	是	1234	需要获取信息的域名 ID。您可以通过 CreateZone API 或 ListZones API 获取域名 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AllocateDNSServerList	Array of String	[ "vip1.volcengine-dns.com", "vip2.volcengine-dns.com" ]	云解析 DNS 分配给域名的 DNS 服务器列表。
AutoRenew	Boolean	false	是否开启域名自动续费。 `true`：开启域名自动续费。 `false`：关闭域名自动续费。
ConfigurationCode	String	monthly_plan_publiczone	该参数已弃用。
DnsSecurity	String	dns_security_standard_inner	DNS DDoS 防护服务的版本。 `dns_security_standard_inner`：安全防护标准版。 `""`：无安全防护版。
ExpiredTime	Long	1691164799000	实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
InstanceNo	String	DNS71279xxxxx9644332	实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
IsNSCorrect	Boolean	false	DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是正常。该参数有以下取值： `true`： `RealDNSServerList`的 DNS 服务器列表包含所有 `AllocateDNSServerList`中的 DNS 服务器。此时，DNS 服务器的配置是正确的。 `false`： `RealDNSServerList`的 DNS 服务器列表包含部分或者未包含 `AllocateDNSServerList`中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
IsSubDomain	Boolean	false	是否是子域名。 `true`：子域名。 `false`：主域名。
RealDNSServerList	Array of String	[ "vip1.volcengine-dns.com", "vip2.volcengine-dns.com" ]	域名实际使用的 DNS 服务器列表。
RecordCount	Integer	0	域名所包含的解析记录的总数。
Remark	String	remark	域名的备注。
Stage	Integer	0	域名的状态。该参数有以下取值： `0`：正常。在该状态下，该域名的解析记录处于生效状态。 `1`：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。 `2`：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。 `3`：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。 API 在查询域名时超时。超时原因可能是网络问题。 `5`：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
Status	Integer	1	该参数已弃用。
SubDomainHost	String	null	子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
TradeCode	String	ultimate_inner	域名的功能版本。该参数有以下取值： `free_inner`：免费版。 `professional_inner`：专业版。 `enterprise_inner`：企业版。 `ultimate_inner`：旗舰版。 `ultimate_exclusive_inner`：尊享版。
UpdatedAt	String	2023-11-23T19:17:32+08:00	域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录
ZoneName	String	xxxxx.com	域名。

请求示例

GET /?Action=QueryZone&Version=2018-08-01&ZID=1234 HTTP/1.1
Host: dns.volcengineapi.com
X-Date: 20240831T120148Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240831/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024083120015514406620910057515C",
    "Action": "QueryZone",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "AllocateDNSServerList": [
      "vip1.volcengine-dns.com","vip2.volcengine-dns.com"
    ],
    "AutoRenew": true,
    "ConfigurationCode": "monthly_plan_publiczone",
    "DnsSecurity": null,
    "ExpiredTime": 1691164799000,
    "InstanceNo": "DNS71279xxxxx9644332",
    "IsNSCorrect": true,
    "IsSubDomain": true,
    "RealDNSServerList": [
      "vip1.volcengine-dns.com","vip2.volcengine-dns.com"]
    ],
    "RecordCount": 0,
    "Remark": "remark",
    "Stage": 0,
    "Status": 1,
    "SubDomainHost": null,
    "TradeCode": "ultimate_inner",
    "UpdatedAt": "2023-11-23T19:17:32+08:00",
    "ZoneName": "xxxxx.com"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrZoneNotFound	zone not found	未找到域名。
500	ErrInternalServer	server internal error	服务内部错误。

最近更新时间：2025.06.23 20:22:15

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #