云解析服务 DNS云解析服务 DNS

文档首页> 云解析服务 DNS> API参考> API> Record Set多线路管理> 查询单个Zone下Record Set列表
更新时间:2021/06/16 GMT+08:00
分享

查询单个Zone下Record Set列表

功能介绍

查询单个Zone下Record Set列表。

URI

GET /v2.1/zones/{zone_id}/recordsets?limit={limit}&offset={offset}&marker={marker}&line_id={line_id}&tags={tags}&status={status}&type={type}&name={name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&search_mode={search_mode}

参数说明请参见表1
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

zone_id

String

所属zone id。仅支持公网zone。

可以通过查询公网Zone列表获取。

marker

String

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

默认值为空。

limit

Integer

每页返回的资源个数。

取值范围:0~500

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

offset

Integer

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

取值范围:0~2147483647

默认值为0。

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

line_id

String

解析线路ID。请参见解析线路类型

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

默认值为空。

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、CNAME、MX、AAAA、TXT、SRV、NS、CAA

详细信息请参见解析记录类型

如果为空,表示查询所有类型的Record Set。

搜索模式固定为精确搜索。

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:升序排序

默认值为空,表示不排序。

search_mode

String

查询条件搜索模式。

取值范围:

  • like:模糊搜索
  • equal:精确搜索

默认值为模糊搜索。

请求

  • 请求参数

  • 请求样例

    查询域名的记录集列表,域名的Zone ID为“2c9eb155587194ec01587224c9f90149”,线路ID为“default_view”。

    GET https://{DNS_Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=&offset=&line_id=default_view

响应

  • 要素说明
    表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、SRV、CAA。

    详细信息请参见解析记录类型

    ttl

    Integer

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

    如果您的服务地址经常更换,建议TTL值设置相对小些,反之,建议设置相对大些。

    records

    Array of strings

    域名解析后的值。

    create_at

    String

    创建时间。

    采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

    update_at

    String

    更新时间。

    采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

    status

    String

    资源状态。

    详细信息请参见资源状态

    default

    Boolean

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

    project_id

    String

    该Record Set所属的项目ID。

    links

    Object

    指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。详细信息请参见表5

    line

    String

    解析线路ID。

    weight

    Integer

    解析记录的权重。

    health_check_id

    String

    健康检查ID。

    alias_target

    Object

    别名记录。详细信息请参见表4

    表4 metadata参数说明

    名称

    参数类型

    说明

    total_count

    Integer

    满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

    表5 links参数说明

    名称

    参数类型

    说明

    self

    String

    当前资源的链接。

    next

    String

    下一页资源的链接。

  • 响应样例
    {
        "links": {
            "self": "https://Endpoint/v2.1/recordsets?limit=1&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149",
            "next": "https://Endpoint/v2.1/recordsets?limit=11&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.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
                },
                "alias_target": null,
                "zone_id": "2c9eb155587194ec01587224c9f90149",
                "zone_name": "example.com.",
                "create_at": "2016-11-17T11:56:03.439",
                "update_at": "2016-11-17T11:56:06.439",
                "default": true,
                "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
                "line": "default_view",
                "weight": 1,
                "health_check_id":null
            },
            {
                "id": "2c9eb155587194ec01587224c9f9014c",
                "name": "example.com.",
                "type": "NS",
                "ttl": 172800,
                "records": [
                    "ns2.hotrot.de.",
                    "ns1.hotrot.de."
                ],
                "status": "ACTIVE",
                "links": {
                    "self": "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
                },
                "alias_target": null,
                "zone_id": "2c9eb155587194ec01587224c9f90149",
                "zone_name": "example.com.",
                "create_at": "2016-11-17T11:56:03.439",
                "update_at": "2016-11-17T11:56:06.439",
                "default": true,
                "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
                "line": "default_view",
                "weight": 1,
                "health_check_id":null
            },
            {
                "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.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
                },
                "alias_target": null,
                "zone_id": "2c9eb155587194ec01587224c9f90149",
                "zone_name": "example.com.",
                "create_at": "2016-11-17T12:03:17.827",
                "update_at": "2016-11-17T12:56:06.439",
                "default": false,
                "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
                "line": "default_view",
                "weight": 1,
                "health_check_id":null
            }
        ],
        "metadata": {
            "total_count": 3
        }
    }

返回值

接口正常的返回值为2xx,例如200、202或者204。

返回值含义以及更多返回值请参考状态码

分享:

    相关文档

    相关产品