ListRecords - 获取解析记录列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

ListRecords - 获取解析记录列表

最近更新时间：2025.06.23 20:22:17首次发布时间：2023.02.08 13:13:03

获取一个域名的解析记录列表。

使用说明

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

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=ListRecords?Version=2022-06-01

调试

API Explorer

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

去调试

请求参数

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

您的 API 请求中必须至少包括 ZID 参数和 RecordIDs 参数其中的一个。否则，返回值中的 Records 参数会是 null。

参数	类型	是否必填	示例值	描述
Action	String	是	ListRecords	要执行的操作，取值：ListRecords。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ZID	Long	否	subnet-3cj8h1e5kij286c6rrt5m	解析记录关联的 VPC 子网 ID。该参数只在域名开启智能解析时有效。如果您不传入该参数，该参数不会作为查询条件。
ProjectName	String	否	default	项目名称。如果您不传入该参数，该参数不会作为查询条件。
Host	String	否	abc	主机记录（域名前缀）。如果您不传入该参数，该参数不会作为查询条件。
Name	String	否	abc.example.com	域名。如果您不传入该参数，该参数不会作为查询条件。
PageNumber	Integer	否	1	页码。页数由获取的解析记录总数和 `PageSize` 确定。默认为 1。
PageSize	String	否	500	每页包含的解析记录的数量。最大值为 500。默认为 10。
SearchMode	String	否	EXACT	查询模式，用于搜索 `Host` 参数。包括以下模式： LIKE（默认）：模糊查询。 EXACT：精确查询。如果您不传入该参数，该参数不会作为查询条件。
Type	String	否	A	记录类型。 A：A 记录。 AAAA：AAAA 记录。 CNAME：CNAME 记录。 TXT：TXT 记录。 MX：MX 记录。 PTR：PTR 记录。记录类型的详细信息参考解析记录类型。如果您不传入该参数，该参数不会作为查询条件。
Value	String	否	10.0.0.1	记录值。如果您不传入该参数，该参数不会作为查询条件。
LastOperator	String	否	210000041	表示最近一次更新解析记录的火山引擎账号的 ID。如果是子账号更新了解析记录，该参数的值是子账号的 ID。如果您不传入该参数，该参数不会作为查询条件。
Line	String	否	default	解析记录的线路。如果您不传入该参数，该参数不会作为查询条件。
RecordIDs	Array of String	否	RecordIDs.1=1234567&RecordIDs.2=2345678	解析记录 ID。您可以通过添加解析记录 API 获取解析记录 ID。您可以输入多个解析记录 ID，例如 `RecordIDs.1=1234567&RecordIDs.2=2345678`。您最多输入 100 个解析记录 ID。您需要确保 RecordIDs 后的数字 N 从小到大且是连续的。如果您不传入该参数，您必须传入 `ZID` 参数。API 会查询 `ZID` 参数所对应的域名下的全部解析记录。

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	`Records` 展示的解析记录所在的页码。
PageSize	Integer	10	每页包含的解析记录的数量。
Records	Array of Object	无	域名的解析记录列表。
Total	Integer	10	解析记录数量。

请求示例

GET https://open.volcengineapi.com/?Action=ListRecords&Version=2022-06-01&PageNumber=1&PageSize=10&ZID=367

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230914165514D4521DF8471E96DA581A",
        "Action": "ListRecords",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-north-1"
    },
    "Result": {
        "page_size": 10,
        "page_number": 1,
        "total": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Total": 1,
        "Records": [
            {
                "ZID": 37424,
                "RecordID": "9079256848785222159",
                "Host": "www",
                "Value": "10.0.0.1",
                "Type": "A",
                "TTL": 600,
                "Enable": false,
                "Remark": "",
                "CreatedAt": "2023-09-14T16:54:51+08:00",
                "UpdatedAt": "2023-09-14T16:54:51+08:00",
                "LastOperator": "210xxxxxx41"
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrDBNotFound	db not found	数据条目未找到
400	ErrZoneNotFound	zone not found	未找到域名
400	ErrAccountInArrears	this account in arrears, you cannot open this service. Please recharge your account	账户欠费，无法开通服务
400	AccountInArrears	您的账户已欠费，无法开通此服务！请前往账户充值	账户欠费，无法开通服务
500	ErrInternalServer	server internal error	服务内部错误