QueryRecord - 获取解析记录详细信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

QueryRecord - 获取解析记录详细信息

最近更新时间：2025.03.10 14:01:38首次发布时间：2022.11.24 20:57:30

获取一条解析记录的详细信息。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryRecord	要执行的操作，取值：QueryRecord。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
FQDN	String	否	www.example.com	（废弃）解析记录的主机名。您可以使用 FQDN（Fully Qualified Domain Name）格式（例如 `www.example.com.`）或 PQDN（Partially Qualified Domain Name）格式（例如 `www.example.com`）。
PQDN	String	否	www.example.com	解析记录的主机名。您可以使用 FQDN（Fully Qualified Domain Name）格式（例如 `www.example.com.`）或 PQDN（Partially Qualified Domain Name）格式（例如 `www.example.com`）。
RecordID	String	否	3170534137672596377	解析记录 ID。该参数有以下说明：如果您设置了 `RecordID`，您就不需要设置 `PQDN`，`Line`，`Type`，`Value` 参数。如果您不设置 `RecordID`，您需要设置 `PQDN`，`Line`，`Type`，`Value` 所有这些参数。
Line	String	否	default	解析记录的线路。该参数的值来自： ListLines API 返回的线路的 `Value` 参数。 ListCustomLines API 返回的线路的 `Line` 参数。域名可以配置的线路取决于该域名的功能版本规格。
ProjectName	String	否	default	解析记录的域名所属项目。默认为 `default`。
Type	String	否	A	解析记录的类型。
Value	String	否	203.0.113.0	解析记录的记录值。

返回参数

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

参数	类型	示例值	描述
CreatedAt	String	2023-04-12T11:21:15+08:00	解析记录的创建时间。
Enable	Boolean	true	该解析记录是否是启用的。该参数有以下取值： `true`：启用。 `false`：禁用。此时，该解析记录不生效。
FQDN	String	@.example.com	（已废弃）解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
Host	String	@	域名的主机记录。如果该参数值是 `@`，表示二级域名本身。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
Line	String	default	解析记录对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 ListLines API 获取。
Operators	Array of String	224xxxxxxx011	调用该 API 的火山引擎的账号 ID。如果是子用户调用该 API，该参数的值是子用户的 ID。
PQDN	String	@.example.com	解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
RecordID	String	3170534137672596377	解析记录的 ID。
RecordSetID	String	MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0	解析记录所在的记录集的 ID。只有 A，AAAA，CNAME 类型的解析记录有记录集。
Remark	String	remark	解析记录的备注。
Type	String	A	记录类型。关于不同类型的记录，参见解析记录类型。该参数的取值如下： `A`：A 记录。 `AAAA`：AAAA 记录。 `CNAME`：CNAME 记录。 `NS`：NS 记录。 `MX`：MX 记录。 `SRV`：SRV 记录。 `TXT`：TXT 记录。
TTL	Integer	600	解析记录的过期时间。单位是秒。
Tags	Array of String	["GTMLock"]	解析记录的标签信息。如果该参数的值包含 GTMLock，则说明该解析记录与火山引擎云调度（GTM）中的 GTM 实例关联。
UpdatedAt	String	2023-04-12T11:21:15+08:00	解析记录最近一次更新的时间。
Value	String	203.0.113.0	添加的记录值。
Weight	Integer	1	解析记录的权重。

请求示例

GET /?Action=QueryRecord&Version=2018-08-01&RecordID=3170534137672596377 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240908T105737Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240908185757060158168038D04A78",
    "Action": "QueryRecord",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
        "RecordID": "3170534137672961176",
        "FQDN": "www.example.com",
        "PQDN": "www.example.com",
        "Host": "www",
        "Type": "A",
        "TTL": 600,
        "Line": "default",
        "Value": "203.0.113.0",
        "Weight": 1000,
        "RecordSetID": "MzE3MDUzNDEzNzY2OTA5ODc5OHx0ZXN0MDIyLnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
        "Enable": true,
        "Tags": [],
        "Remark": "",
        "CreatedAt": "2023-05-24T16:50:31+08:00",
        "UpdatedAt": "2023-05-24T16:50:31+08:00",
        "Operators": [
            "21xxxxxx1"
        ]
    }
}

错误码

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

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