You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/私网解析 PrivateZone/API 参考/记录集管理接口/ListRecordSets-获取记录集列表
ListRecordSets-获取记录集列表
最近更新时间：2024.08.23 14:49:51首次发布时间：2023.02.08 13:13:19
我的收藏

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

参见 基本概念 了解什么是记录集。

注意

在调用该 API 之前，您必须确保在调用 CreatePrivateZone API 创建域名时开启了负载均衡功能。如果您的域名没有开启负载均衡功能，您可以调用 UpdatePrivateZone API 更新负载均衡配置。否则，API 会返回 ErrWeightDisabled 错误。

请求说明

  • 请求方式：GET
  • 请求地址：https://open.volcengineapi.com?Action=ListRecordSets?Version=2022-06-01

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是ListRecordSetsAPI 的名称。该参数的取值是 ListRecordSets。
VersionString是2022-06-01API 的版本。该参数的取值是 2022-06-01。
ZIDInteger是1234域名 ID。您可以通过以下 API 获取：
PageNumberInteger否1页码。页数由获取的记录集总数和 PageSize 确定。
默认为 1。
PageSizeInteger否10每页包含的记录集的数量。
默认为 10。
SearchModeString否EXACT查询模式，用于搜索 Host 参数。包括以下模式：
  • LIKE：模糊查询。例如 %www%。
  • EXACT（默认）：精确查询。例如 www。

HostString否www主机记录（域名前缀）。如果您不传入该参数，则该参数不作为查询条件。
RecordSetIDString否OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w解析记录记录集 ID。如果您已经通过该 API 获取了 RecordSetID，可以传入该参数作为查询条件。如果您不传入该参数，则该参数不作为查询条件。

返回参数

ResponseMetadata 对象

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

Result 对象

名称
类型
描述
TotalCount
Integer
记录集的总数量。
PageNumber
Integer
RecordSets 展示的记录集所在的页码。
PageSize
Integer
每页包含的记录集的数量。
RecordSets
JSON Object
记录集列表。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListRecordSets&Version=2022-06-01&PageNumber=1&PageSize=10&ZID=1135&Host=www

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221216154121E2DE2FD52644751C1DDF",
        "Action": "ListRecordSets",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10,
        "RecordSets": [
            {
                "ID": "OTA3OTI1Njg0ODc3ODkyMTA3M3x3d3cuaW50ZXJuYWwwMDMuY29tLnxBfGRlZmF1bHQ7MC4wLjAuMC8w",
                "FQDN": "www.internal003.com",
                "Host": "www",
                "Type": "A",
                "Line": "default",
                "WeightEnabled": false
            }
        ]
    }
}

错误码

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