You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取记录集列表

最近更新时间：2023.12.15 10:24:14

首次发布时间：2023.02.08 13:13:19

我的收藏

API 说明

API 名称：ListRecordSets。
API 域名：open.volcengineapi.com。
API 描述：获取指定域名的负载均衡解析记录集。

注意

在调用该 API 之前，您必须确保在调用 添加域名 API 创建域名时开启负载均衡。如果您的域名没有开启负载均衡，您可以调用 更新域名配置 API 更新负载均衡配置。

请求方法

GET

请求参数

除了以下参数，您还需要在请求头中指定 请求方法 并包含 签名参数。

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 ListRecordSets。
VersionString查询参数是API 的版本。该参数的取值是 2022-06-01。
PageNumberInteger查询参数否页码。页数由获取的域名总数和 PageSize 确定。
默认为 1。

PageSize

Integer

查询参数

否

每页包含的域名的数量。
默认为 10。
返回结果会将获取的域名进行分页显示。页数由获取的域名总数和 PageSize 确定。

SearchMode

String

查询参数

否

查询模式，用于搜索 Host 参数。包括以下模式：

  • LIKE：模糊查询。例如 %www%。
  • EXACT：精确查询。例如 www。


默认为模糊查询。

HostString查询参数否主机记录，例如 www。
RecordSetIDString查询参数否解析记录记录集 ID。如果您已经通过该 API 获取了 RecordSetID，可以填入该参数作为查询条件。
ZIDInteger查询参数是域名 ID。您可以通过以下 API 获取：

响应正文

参数名称
数据类型
参数说明
ResponseMetadata
Object
响应的元数据。
Result
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
            }
        ]
    }
}