ListRecordSets - 获取记录集列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListRecordSets - 获取记录集列表

最近更新时间：2025.06.23 20:22:16首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListRecordSets	要执行的操作，取值：ListRecordSets。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
RecordSetID	String	否	MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0	记录集 ID。一个解析记录集中的解析记录具有相同的域名，主机记录，线路和类型。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
ZID	Long	是	304092	需要获取解析记录集的域名 ID。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的解析记录集。该参数的默认值是 1。
PageSize	Integer	否	10	每页包含的解析记录集的数量。系统会将获取的解析记录集进行分页显示。页数是由获取的解析记录集总数和 `PageSize` 确定。该参数的默认值是 `10`，最大值是 `500`。
SearchMode	String	否	like	`Host` 的匹配模式。该参数有以下取值： `like`（默认）：模糊匹配。 `exact`：精确匹配。
Host	String	否	@	记录集的主机记录。如果该参数值是 `@`，表示二级域名本身。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	`RecordSets` 展示的解析记录集所在的页码。
PageSize	Integer	1	每个分页所包含的解析记录集的数量。
TotalCount	Integer	15	返回的解析记录集总数。该参数值不受 `PageNumber` 参数的影响。假设您指定的 `PageNumber` 没有包含任何解析记录集。此时 `RecordSets` 参数不会展示任何解析记录集。但是 `TotalCount` 仍然会显示该 API 实际获取到的解析记录集总数。
RecordSets	Array of Object	无	解析记录集列表。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024090819350118422712416771C64C",
    "Action": "ListRecordSets",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 1,
    "TotalCount": 15,
    "RecordSets": {
      "ID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
      "FQDN": "@.example.com",
      "PQDN": "@.example.com",
      "Host": "@",
      "Type": "A",
      "Line": "default",
      "WeightEnabled": true
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrZoneNotFound	zone not found	未找到域名。
400	ErrZoneInactive	zone is inactive	域名待找回。
400	ErrPageSizeNotValid	page size must be less than 500 when search	分页查找的记录数量不能大于500。
500	ErrInternalServer	server internal error	服务内部错误。