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

获取解析记录列表

最近更新时间：2024.03.12 19:40:35

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

我的收藏

API 说明

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

请求方法

GET

请求参数

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

注意

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

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

PageSize

Integer

查询参数

否

每页包含的解析记录的数量。
默认为 10。最大值为 500。
返回结果会将获取的解析记录进行分页显示。页数由获取的解析记录总数和 PageSize 确定。

SearchMode

String

查询参数

否

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

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


默认为模糊查询。

SearchOrderString查询参数否
  • asc：查询结果按照解析记录的最后一次更新时间升序排列。
  • desc：查询结果按照解析记录最后一次更新时间降序排列。
HostString查询参数否主机记录，例如 www。
NameString查询参数否域名，例如 www.volcengine.com。
TypeString查询参数否记录类型。
  • A：A 记录。
  • AAAA：AAAA 记录。
  • CNAME：CNAME 记录。
  • TXT：TXT 记录。
  • MX：MX 记录。
  • PTR：PTR 记录。
记录类型的详细信息参考 解析记录类型。
ValueString查询参数否记录值，例如 10.0.1.128。
LastOperatorString查询参数否表示最近一次更新解析记录的火山引擎账号的 ID。如果是子账号更新了解析记录，该参数的值是子账号的 ID。
LineString查询参数否解析记录关联的 VPC 子网 ID。该参数只在域名开启智能解析时有效。
ZIDInteger查询参数否域名 ID。您可以通过以下 API 获取域名 ID：
如果您不传入该参数，您必须传入 RecordIDs 参数。API 会查询所有域名下的解析记录，且 RecordIDs 参数会作为过滤条件。
RecordIDsString查询参数否解析记录 ID。您可以通过 添加解析记录 API 获取解析记录 ID。您可以设置多个解析记录 ID，例如 RecordIDs=9079256848785222159&RecordIDs=907925655585228777。

如果您不传入该参数，您必须传入 ZID 参数。API 会查询 ZID 参数所对应的域名下的全部解析记录。

响应正文

参数名称
数据类型
参数说明
ResponseMetadata
Object
响应的元数据。
Result
Object
返回结果。

示例

请求示例

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": "1.1.1.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"
            }
        ]
    }
}