You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云解析 DNS/API 参考/解析记录管理接口/ListRecords-获取解析记录列表
ListRecords-获取解析记录列表
最近更新时间：2024.07.01 15:42:31首次发布时间：2022.11.24 20:57:30
我的收藏

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

使用说明

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

请求说明

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

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是ListRecordsAPI 的名称。该参数的取值是 ListRecords。
VersionString是2018-08-01API 的版本。该参数的取值是 2018-08-01。
ZIDInteger是304092需要获取解析记录的域名 ID。
PageSizeInteger否10每页包含的解析记录的数量。
系统会将获取的解析记录进行分页显示。页数是由获取的解析记录总数和 PageSize 确定。该参数的默认值是 10，最大值是 500。
PageNumberInteger否1页码。API 返回该页码所包含的解析记录。该参数的默认值是 1。
SearchOrderString否asc如何对返回的解析记录列表进行排序。排序的字段是解析记录的创建时间。该参数有以下取值：
  • asc（默认）：升序排序。
  • desc：降序排序。
SearchModeString否likeHost 的匹配模式。该参数有以下取值： ：
  • like（默认）：模糊匹配。
  • exact：精确匹配。
HostString否@域名的主机记录。如果该参数值是 @，表示二级域名本身。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
LineString否Default解析记录的线路。该参数的值来自： 域名可以配置的线路取决于该域名的 功能版本规格。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
TypeString否A解析记录的类型。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
ValueString否1.1.1.1解析记录的记录值。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。

返回参数

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": [],
                "Remark": "",
                "CreatedAt": "2022-11-09T10:05:08+08:00",
                "UpdatedAt": "2022-11-09T10:05:08+08:00",
                "Operators": [
                    "2100xxxx011"
                ]
            }
        ]
    }
}

错误码

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