文档首页/ 云解析服务 DNS/ API参考/ API/ Record Set管理/ 查询单个Zone下Record Set列表
更新时间：2024-07-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个Zone下Record Set列表

功能介绍

查询单个Zone下Record Set列表

调用方法

请参见如何调用API。

URI

GET /v2/zones/{zone_id}/recordsets

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

是

String

所属zone id。

最小长度：32

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

search_mode

否

String

查询条件搜索模式。

取值范围：

like：模糊搜索 equal：精确搜索

marker

否

String

分页查询起始的资源ID，为空时为查询第一页。

默认值为空。

limit

否

Integer

每页返回的资源个数。

取值范围：0~500

取值一般为10，20，50。默认值为500。

offset

否

Integer

分页查询起始偏移量，表示从偏移量的下一个资源开始查询。

取值范围：0~2147483647

默认值为0。

当前设置marker不为空时，以marker为分页起始标识。

tags

否

String

资源标签。

取值格式：key1,value1|key2,value2

多个标签之间用"|"分开，每个标签的键值用英文逗号","相隔。

status

否

String

待查询的Record Set的状态。 取值范围：ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE

type

否

String

待查询的Record Set的记录集类型。公网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。内网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、SRV。

name

否

String

待查询的Record Set的域名中包含此name。

搜索模式默认为模糊搜索。

默认值为空。

id

否

String

待查询的Record Set的id包含此id。

搜索模式默认为模糊搜索。

默认值为空。

sort_key

否

String

查询结果中Record Set列表的排序字段。

取值范围为：

name：域名 type：记录集类型 默认值为空，表示不排序。

sort_dir

否

String

查询结果中Record Set列表的排序方式。

取值范围：

desc：降序排序 asc：升序排序 默认值为空，表示不排序。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时，需要包含一个next链接指向下一页。

recordsets

Array of ListRecordSets objects

recordset列表对象。

metadata

metadata object

返回满足过滤条件的资源总数。
表5 ListRecordSets

参数

参数类型

描述

id

String

Record Set的ID。

name

String

Record Set的名称。

description

String

Record Set的描述信息。

zone_id

String

托管该记录的zone_id。

zone_name

String

托管该记录的zone_name。

type

String

记录类型。

ttl

Integer

解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。

records

Array of strings

域名解析后的值。

create_at

String

创建时间。

update_at

String

更新时间。

status

String

资源状态。

default

Boolean

标识是否由系统默认生成，系统默认生成的Record Set不能删除。

project_id

String

该Record Set所属的项目ID。

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时，需要包含一个next链接指向下一页。
表6 pageLink

参数

参数类型

描述

self

String

当前资源的链接。

next

String

下一页资源的链接。
表7 metadata

参数

参数类型

描述

total_count

Integer

满足查询条件的资源总数，不受分页（即limit、offset参数）影响。

请求示例

无

响应示例

状态码： 200

查询单个Zone下Record Set列表响应。

{
  "links" : {
    "self" : "https://Endpoint/v2/recordsets?limit=10&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149",
    "next" : "https://Endpoint/v2/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149"
  },
  "recordsets" : [ {
    "id" : "2c9eb155587194ec01587224c9f9014a",
    "name" : "example.com.",
    "type" : "SOA",
    "ttl" : 300,
    "records" : [ "ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)" ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587194ec01587224c9f9014c",
    "name" : "example.com.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722b6ac30007",
    "name" : "www.example.com.",
    "description" : "This is an example record set.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "192.168.10.2", "192.168.10.1" ],
    "status" : "PENDING_CREATE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T12:03:17.827",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  } ],
  "metadata" : {
    "total_count" : 3
  }
}

状态码

状态码

描述

200

查询单个Zone下Record Set列表响应。

错误码

请参见错误码。

父主题： Record Set管理