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

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListRecordSets-获取记录集列表

最近更新时间：2024.07.01 20:49:07首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

请求参数

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

Query

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

返回参数

ResponseMetadata 对象

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

Result 对象

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

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230412153500E9CB7CBCE69BE15F449A",
        "Action": "ListRecordSets",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 4,
        "PageNumber": 1,
        "PageSize": 1,
        "RecordSets": [
            {
                "ID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
                "FQDN": "@.example.com",
                "PQDN": "@.example.com",
                "Host": "@",
                "Type": "A",
                "Line": "default",
                "WeightEnabled": false
            }
        ]
    }
}

错误码

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