Querying Record Sets

Function

This API is used to query record sets.

Calling Method

For details, see Calling APIs.

URI

GET /v2/recordsets

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
zone_type	No	String	Zone type of the record set to be queried. The value can be public or private. public (default): Record sets of public zones are queried. private: Record sets of private zones are queried. Fuzzy search will work. If the value is left blank, record sets of public zones are queried by default.
marker	No	String	Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. It is left blank by default.
search_mode	No	String	Search mode. The options are as follows: like: fuzzy search equal: exact search
limit	No	Integer	Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50. The default value is 500.
offset	No	Integer	Start offset of pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647. The default value is 0. If marker is not left blank, the query starts from the resource specified by marker.
tags	No	String	Resource tag. The format is as follows: key1,value1\|key2,value2. Multiple tags are separated by vertical bar (\|). The key and value of each tag are separated by comma (,).
status	No	String	Status of the record sets to be queried. The value can be ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
type	No	String	Record set type.- Public zones: The type can be A, AAAA, MX, CNAME, TXT, NS, SRV or CAA.- Private zones: The value can be A, AAAA, MX, CNAME, TXT or SRV.
name	No	String	Name of the record set to be queried. Fuzzy search will work. It is left blank by default.
id	No	String	ID of the record set to be queried. Fuzzy search will work. It is left blank by default.
records	No	String	Records included in the values of record sets to be queried. Fuzzy search will work. It is left blank by default.
sort_key	No	String	Sorting field of the record sets in the list. Value options: name: domain name type: record set type The default value is left blank, indicating that the record sets are not sorted.
sort_dir	No	String	Sorting order of the record sets in the list. Value options: desc: descending order asc: ascending order The default value is left blank, indicating that the record sets are not sorted.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
links	pageLink object	Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.
recordsets	Array of ListRecordSetsWithTags objects	Record set list
metadata	metadata object	Number of resources that meet the query condition

**Table 4** ListRecordSetsWithTags
Parameter	Type	Description
id	String	Record set ID
name	String	Record set name
description	String	Record set description
zone_id	String	Zone ID of the record set
zone_name	String	Zone name of the record set
type	String	Record set type
ttl	Integer	Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.
records	Array of strings	Record set value
create_at	String	Time when the record set was created
update_at	String	Time when the record set was updated
status	String	Resource status
default	Boolean	Whether the record set is generated by the system. A system-generated record set cannot be deleted.
project_id	String	Project ID of the record set
links	pageLink object	Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.
tags	Array of tag objects	Resource tag

**Table 5** pageLink
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

**Table 6** tag
Parameter	Type	Description
key	String	Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,\|/) or start or end with spaces.
value	String	Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,\|/) or start or end with spaces.

**Table 7** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying the record sets

{
  "links" : {
    "self" : "https://Endpoint/v2/recordsets",
    "next" : "https://Endpoint/v2/recordsets?id=&limit=10&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
  }
}