You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取域名详细信息

最近更新时间：2023.06.14 15:32:47

首次发布时间：2022.11.24 20:57:30

我的收藏

API 说明

API 名称：QueryZone。
API 域名：open.volcengineapi.com。
API 描述：在火山引擎云解析（DNS）中，获取一个域名的详细信息。

请求方法

GET

使用限制

每秒最多调用 20 次

请求参数

除了以下参数，您还需要在请求头中指定 请求方法 并包含 签名参数。

参数名称数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 QueryZone。
VersionString查询参数是API 的版本。该参数的取值是 2018-08-01。
ZIDInteger查询参数是需要获取信息的域名 ID。您可以调用 ListZones API 获取域名 ID。

响应正文

ResponseMetadata 对象

参数名称
数据类型
参数说明
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在区域。

Result 对象

参数名称
数据类型参数说明
InstanceNoString实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
ZoneNameString域名。
RemarkString域名的备注。
ConfigurationCodeString该参数已弃用。
StatusInteger该参数已弃用。

AllocateDNSServerList

String[]

云解析 DNS 分配给域名的 NS 服务器列表。

RealDNSServerList

String[]

域名实际使用的 NS 服务器列表。

IsNSCorrect

Boolean

NS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：

  • true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。

  • false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。

ExpiredTime

Integer

实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。

Stage

Integer

域名的状态。该参数有以下取值：

  • 0：正常。

  • 1：域名待找回。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要在控制台根据提示验证您的域名所有权。

  • 2：未使用TrafficRoute解析。该状态表示分配给该域名的 DNS 服务器不是 TrafficRoute 的 DNS 服务器。此时，您在云解析 DNS 中创建的解析记录将无法生效。

  • 3：异常。引起该状态的常见原因如下：

    • 域名未实名认证导致域名被注册局或注册商停用。

    • 域名未配置 DNS 服务器。

    • 域名未注册。

    • API 在查询域名时超时。超时原因可能是网络问题引起的。

  • 5：请变更DNS服务器。该状态表示域名当前的 DNS 服务器已配置为 TrafficRoute 的 DNS 服务器，但因服务升级或变更需要变更。请在域名注册商处将 DNS 服务器修改为 TrafficRoute 分配的 DNS 服务器。

TradeCode

String

域名的功能版本。该参数有以下取值：

  • free_inner：免费版。

  • professional_inner：专业版。

  • enterprise_inner：企业版。

  • ultimate_inner：旗舰版。

  • ultimate_exclusive_inner：尊享版。

UpdatedAtString域名最近一次的更新时间。更新操作包括更新域名备注、在域名下创建解析记录等。
RecordCountInteger域名所包含的解析记录的总数。

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=QueryZone&ZID=1376

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230411150314CE53198BCFE9484824BA",
        "Action": "QueryZone",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "InstanceNo": "DNS71279xxxxx9644332",
        "ZoneName": "xxxxx.com",
        "Remark": "",
        "ExpiredTime": 1691164799000,
        "ConfigurationCode": "monthly_plan_publiczone",
        "Status": 1,
        "AllocateDNSServerList": [
            "ns1.volcdns.com",
            "ns2.volcdns.com",
            "ns3.volcdns.com",
            "ns4.volcdns.com",
            "ns5.volcdns.com"
        ],
        "RealDNSServerList": [
            "ns1.volcdns.com",
            "ns2.volcdns.com",
            "ns3.volcdns.com",
            "ns4.volcdns.com",
            "ns5.volcdns.com"
        ],
        "IsNSCorrect": false,
        "Stage": 2,
        "TradeCode": "ultimate_inner",
        "UpdatedAt": "2023-04-03T19:17:32+08:00",
        "RecordCount": 0
    }
}