You need to enable JavaScript to run this app.
导航

获取记录集列表

最近更新时间2023.12.06 10:39:30

首次发布时间2022.11.24 20:57:30

API 说明

API 名称:ListRecordSets
API 域名:open.volcengineapi.com
API 描述:获取指定域名的解析记录集列表。

请求方法

GET

调用限制

每秒最多调用 50 次。

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 ListRecordSets
VersionString查询参数API 的版本。该参数的取值是 2018-08-01
ZIDInteger查询参数获取特定 ID 的域名中的解析记录集。

PageSize

Integer

查询参数

每页包含的解析记录集的数量。

系统会将获取的解析记录集进行分页显示。页数是由获取的解析记录集总数和 PageSize 确定。

该参数的默认值是 10,最大值是 500

PageNumberInteger查询参数页码。API 返回该页码所包含的解析记录集。该参数的默认值是 1

SearchMode

String

查询参数

Host 的匹配模式。该参数有以下取值:

  • like:模糊匹配。

  • exact:精确匹配。

该参数的默认值是 like

HostString查询参数获取包含特定主机记录的解析记录集。如果该参数值是 @,表示二级域名本身。
RecordSetIDString查询参数获取特定 ID 的解析记录集。一个解析记录集中的解析记录具有相同的主机名,主机记录,线路和类型。

响应正文

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
            }
        ]
    }
}