查询Record Set列表
功能介绍
查询租户Record Set资源列表。
URI
GET /v2/recordsets
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
zone_type |
否 |
String |
待查询的Record Set的域名类型。 取值范围：public、private
搜索模式默认为模糊搜索。 默认值为public。 |
|
marker |
否 |
String |
分页查询起始的资源ID，为空时为查询第一页。 默认值为空。 |
|
limit |
否 |
Integer |
每页返回的资源个数。 取值范围：0~500 取值一般为10，20，50。默认值为500。 |
|
offset |
否 |
Integer |
分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 当前设置marker不为空时，以marker为分页起始标识。 |
|
tags |
否 |
String |
资源标签。 取值格式：key1,value1|key2,value2 多个标签之间用"|"分开，每个标签的键值用英文逗号","相隔。 多个标签之间为“与”的关系。 搜索模式为精确搜索。如果资源标签值value是以*开头时，则按照*后面的值全模糊匹配。 默认值为空。 |
|
status |
否 |
String |
待查询的Record Set的状态。 取值范围：ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE 详细信息请参见资源状态。 搜索模式默认为模糊搜索。 默认值为空。 |
|
type |
否 |
String |
待查询的Record Set的记录集类型。 取值范围：A、AAAA、MX、CNAME、TXT、NS、SOA、SRV、PTR（仅限内网Zone）、CAA（仅限公网Zone）。 详细信息请参见解析记录类型。 搜索模式固定为精确搜索。 默认值为空。 |
|
name |
否 |
String |
待查询的Record Set的域名中包含此name。 搜索模式默认为模糊搜索。 默认值为空。 |
|
id |
否 |
String |
待查询的Record Set的id包含此id。 搜索模式默认为模糊搜索。 默认值为空。 |
|
records |
否 |
String |
待查询的Record Set的值中包含此records。 搜索模式默认为模糊搜索。 默认值为空。 |
|
sort_key |
否 |
String |
查询结果中Record Set列表的排序字段。 取值范围：
默认值为空，表示不排序。 |
|
sort_dir |
否 |
String |
查询结果中Record Set列表的排序方式。 取值范围：
默认值为空，表示不排序。 |
请求
响应
- 要素说明
表2 响应样例的要素说明 名称
参数类型
说明
links
Object
指向当前资源或者其他资源的链接。当查询需要分页时，需要包含一个next链接指向下一页。
详细信息请参见表5。
recordsets
Array of object
recordset列表对象，详细信息请参见表3。
metadata
Object
返回满足过滤条件的资源总数，详细信息请参见表4。
表3 recordsets字段说明 名称
参数类型
说明
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
记录类型。
取值范围：A、AAAA、MX、CNAME、TXT、NS、SOA、SRV、PTR（仅限内网Zone）、CAA（仅限公网Zone）。
详细信息请参见解析记录类型。
ttl
Integer
解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。
如果您的服务地址经常更换，建议TTL值设置相对小些，反之，建议设置相对大些。
取值范围：
- 公网解析：1~2147483647。
- 内网解析：300~2147483647。
默认值为300s。
records
Array of strings
域名解析后的值。
create_at
String
创建时间。
格式：yyyy-MM-dd'T'HH:mm:ss.SSS
update_at
String
更新时间。
格式：yyyy-MM-dd'T'HH:mm:ss.SSS
status
String
资源状态。
详细信息请参见资源状态。
default
Boolean
标识是否由系统默认生成，系统默认生成的Record Set不能删除。
project_id
String
该Record Set所属的项目ID。
links
Object
指向当前资源或者其他资源的链接。当查询需要分页时，需要包含一个next链接指向下一页。
详细信息请参见表5。
tags
Array of tag objects
资源标签。
取值格式：key1,value1|key2,value2
多个标签之间用"|"分开，每个标签的键值用英文逗号","相隔。
多个标签之间为“与”的关系。
关于资源标签，请参见表6。
搜索模式为精确搜索。如果资源标签值value是以*开头时，则按照*后面的值全模糊匹配。
默认值为空。
- 响应样例
{ "links": { "self": "https://Endpoint/v2/recordsets", "next": "https://Endpoint/v2/recordsets?id=&limit=11&marker=2c9eb155587194ec01587224c9f9014a" }, "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-17T11: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-17T11:56:03.827", "default": true, "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c" }, { "id": "2c9eb155587228570158722996ca0002", "name": "example.org.", "type": "SOA", "ttl": 300, "records": [ "ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)" ], "status": "ACTIVE", "links": { "self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002" }, "zone_id": "2c9eb155587228570158722996c50001", "zone_name": "example.org.", "create_at": "2016-11-17T12:01:17.996", "update_at": "2016-11-17T12:56:03.827", "default": true, "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c" }, { "id": "2c9eb155587228570158722996ca0004", "name": "example.org.", "type": "NS", "ttl": 172800, "records": [ "ns2.hotrot.de.", "ns1.hotrot.de." ], "status": "ACTIVE", "links": { "self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004" }, "zone_id": "2c9eb155587228570158722996c50001", "zone_name": "example.org.", "create_at": "2016-11-17T12:01:17.996", "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": "ACTIVE", "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": 5 } }
