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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2024.07.01 15:42:19首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`QueryRecord`	API 的名称。该参数的取值是 `QueryRecord`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。
RecordID	String	否	`3170534137672961176`	解析记录 ID。该参数有以下说明：如果您设置了 `RecordID`，您就不需要设置 `PQDN`，`Line`，`Type`，`Value` 参数。如果您不设置 `RecordID`，您需要设置 `PQDN`，`Line`，`Type`，`Value` 所有这些参数。
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`）。
Line	String	否	`Default`	解析记录的线路。该参数的值来自： ListLines API 返回的线路的 `Value` 参数。 ListCustomLines API 返回的线路的 `Line` 参数。域名可以配置的线路取决于该域名的功能版本规格。
Type	String	否	`A`	解析记录的类型。
Value	String	否	`1.1.1.1`	解析记录的记录值。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
RecordID	String	解析记录的 ID。
FQDN	String	（废弃）表示解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
PQDN	String	解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
Host	String	解析记录所包含的主机记录。如果该参数值是 `@`，表示二级域名本身。
Type	String	解析记录的类型。
TTL	Integer	解析记录的过期时间。单位是秒。
Line	String	解析记录所对应的线路代号。
Value	String	解析记录包含的记录值。
Weight	Integer	解析记录的权重。
RecordSetID	String	解析记录所在的记录集的 ID。只有 A，AAAA，CNAME 类型的解析记录有记录集。
Enable	Boolean	该解析记录是否被启用。该参数有以下取值： `true`：启用。 `false`：禁用。此时，该解析记录不生效。
Tags	Array of String	解析记录的标签信息。如果该参数的值包含 `GTMLock`，则说明该解析记录与火山引擎云调度（GTM）中的 GTM 实例关联。
Remark	String	解析记录的备注。
CreatedAt	String	解析记录的创建时间。
UpdatedAt	String	解析记录最近一次更新的时间。
Operators	String[]	最近一次更新该解析记录的火山引擎账号的 ID。如果是子账号更新该解析记录，该参数的值是子账号的 ID。

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=QueryRecord&RecordID=3170534137672596377

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023052416510645D0D3D35334AD2EA31D",
        "Action": "QueryRecord",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "RecordID": "3170534137672961176",
        "FQDN": "www.example.com",
        "PQDN": "www.example.com",
        "Host": "www",
        "Type": "A",
        "TTL": 600,
        "Line": "default",
        "Value": "2.2.2.2",
        "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"
        ]
    }
}

错误码

您可访问公共错误码，获取详细信息。