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

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

请求说明

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

请求参数

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

注意

您的 API 请求中必须至少包括 ZID 参数和 RecordIDs 参数其中的一个。否则，返回值中的 Records 参数会是 null。

Query

名称类型是否必选示例值描述
ActionString是ListRecordsAPI 的名称。该参数的取值是 ListRecords。
VersionString是2022-06-01API 的版本。该参数的取值是 2022-06-01。
PageNumberInteger否1页码。页数由获取的解析记录总数和 PageSize 确定。默认为 1。
PageSizeInteger否500每页包含的解析记录的数量。最大值为 500。默认为 10。
SearchModeString否www查询模式，用于搜索 Host 参数。包括以下模式：
  • LIKE（默认）：模糊查询。例如 %www%。
  • EXACT：精确查询。例如 www。
如果您不传入该参数，该参数不会作为查询条件。
SearchOrderString否asc查询结果的排列顺序。
  • asc：查询结果按照解析记录的最后一次更新时间升序排列。
  • desc（默认）：查询结果按照解析记录最后一次更新时间降序排列。
如果您不传入该参数，该参数不会作为查询条件。
HostString否www主机记录（域名前缀）。如果您不传入该参数，该参数不会作为查询条件。
NameString否example.com域名，例如 example.com。如果您不传入该参数，该参数不会作为查询条件。
TypeString否A记录类型。
  • A：A 记录。
  • AAAA：AAAA 记录。
  • CNAME：CNAME 记录。
  • TXT：TXT 记录。
  • MX：MX 记录。
  • PTR：PTR 记录。
记录类型的详细信息参考 解析记录类型。如果您不传入该参数，该参数不会作为查询条件。
ValueString否10.0.1.128记录值。如果您不传入该参数，该参数不会作为查询条件。
LastOperatorString否210xxxxxx41表示最近一次更新解析记录的火山引擎账号的 ID。如果是子账号更新了解析记录，该参数的值是子账号的 ID。如果您不传入该参数，该参数不会作为查询条件。
LineString否subnet-3cj8h1e5kij286c6rrt5m****解析记录关联的 VPC 子网 ID。该参数只在域名开启智能解析时有效。如果您不传入该参数，该参数不会作为查询条件。
ZIDInteger否210xxxxxx41域名 ID。您可以通过以下 API 获取域名 ID：
如果您不传入该参数，您必须传入 RecordIDs.N 参数。API 会查询所有域名下的解析记录，且 RecordIDs.N 参数会作为查询条件。
RecordIDs.NString否RecordIDs.1=1234567&RecordIDs.2=2345678解析记录 ID。您可以通过 添加解析记录 API 获取解析记录 ID。您可以输入多个解析记录 ID，例如 RecordIDs.1=1234567&RecordIDs.2=2345678。您最多输入 100 个解析记录 ID。您需要确保 RecordIDs 后的数字 N 从小到大且是连续的。
如果您不传入该参数，您必须传入 ZID 参数。API 会查询 ZID 参数所对应的域名下的全部解析记录。

返回参数

ResponseMetadata 对象

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

Result 对象

名称
类型
描述
page_size
Integer
（已废弃）每页包含的解析记录的数量。
page_number
Integer
（已废弃）表示 Records 展示的解析记录所在的页码。
total
Integer
（已废弃）解析记录数量。
PageSize
Integer
每页包含的解析记录的数量。
PageNumber
Integer
表示 Records 展示的解析记录所在的页码。
Total
Integer
解析记录数量。
Records
Array of Objects
域名的解析记录列表。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListRecords&Version=2022-06-01&PageNumber=1&PageSize=10&ZID=367

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230914165514D4521DF8471E96DA581A",
        "Action": "ListRecords",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-north-1"
    },
    "Result": {
        "page_size": 10,
        "page_number": 1,
        "total": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Total": 1,
        "Records": [
            {
                "ZID": 37424,
                "RecordID": "9079256848785222159",
                "Host": "www",
                "Value": "10.0.0.1",
                "Type": "A",
                "TTL": 600,
                "Enable": false,
                "Remark": "",
                "CreatedAt": "2023-09-14T16:54:51+08:00",
                "UpdatedAt": "2023-09-14T16:54:51+08:00",
                "LastOperator": "210xxxxxx41"
            }
        ]
    }
}

错误码

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