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

获取解析记录列表

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

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

我的收藏

API 说明

API 名称：ListRecords。
API 域名：open.volcengineapi.com。
API 描述：获取某个域名的解析记录列表。

请求方法

GET

调用限制

每秒最多调用 100 次。

请求参数

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

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

PageSize

Integer

查询参数

否

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

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

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

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

SearchOrder

String

查询参数

否

如何对返回的解析记录列表进行排序。排序的字段是解析记录的创建时间。

该参数有以下取值：

  • asc：升序排序。

  • desc：降序排序。

该参数的默认值是 asc。

SearchMode

String

查询参数

否

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

  • like：模糊匹配。

  • exact：精确匹配。

该参数的默认值是 like。

HostString查询参数否获取包含特定主机记录的解析记录。如果该参数值是 @，表示二级域名本身。
LineString查询参数否获取相应线路代号的解析记录。该参数的值来自 ListLines API 返回的线路的 Value 参数。
TypeString查询参数否获取特定类型的解析记录。
ValueString查询参数否获取特定记录值的解析记录。

响应正文

ResponseMetadata 对象

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

Result 对象

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

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=ListRecords&Version=2018-08-01&ZID=304092&PageSize=1

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230412142536C2B75D467F4E3722AAE6",
        "Action": "ListRecords",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 15,
        "PageNumber": 1,
        "PageSize": 1,
        "Records": [
            {
                "RecordID": "3170534137670303887",
                "FQDN": "www.example.com",
                "PQDN": "www.example.com",
                "Host": "www",
                "Type": "A",
                "TTL": 600,
                "Line": "default",
                "Value": "1.1.1.1",
                "Weight": 1,
                "RecordSetID": "MzE3MDUzNDEzNzY2OTA5ODc5OHx3d3cueWFtYXNpdGUudG9wLnxBfGRlZmF1bHQ=",
                "Enable": true,
                "Tags": [],
                "CreatedAt": "2022-11-09T10:05:08+08:00",
                "UpdatedAt": "2022-11-09T10:05:08+08:00",
                "Operators": [
                    "2100xxxx011"
                ]
            }
        ]
    }
}