Querying Record Sets in a Zone

Function

Query all record sets in a specified zone.

URI

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

Request

• Request parameters

  None

• Example request

  Query record sets in the zone whose ID is 2c9eb155587194ec01587224c9f90149:

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

Response

• Parameter description

  Table 2 Parameters in the response

  Parameter	Type	Description
  links	Object	Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5.
  recordsets	Array of object	Record set list object. For details, see Table 3.
  metadata	Object	Total number of resources that meet the filter criteria. For details, see Table 4.

  Table 3 Description of the recordsets field

  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 The value can be A, AAAA, MX, CNAME, TXT, SRV, or PTR. For details, see Record Set Type.
  ttl	Integer	Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect. If your service address is frequently changed, set TTL to a smaller value.
  records	Array of strings	Record set value
  create_at	String	Time when the record set was created The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.
  update_at	String	Time when the record set was updated The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.
  status	String	Resource status For details, see Resource Status.
  default	Boolean	Whether the record set is created by default. A default record set cannot be deleted.
  project_id	String	Project ID of the record set
  links	Object	Link to the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. For details, see Table 5.

  Table 4 Description of the metadata field

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

  Table 5 Parameters in the links field

  Parameter	Type	Description
  self	String	Link to the current resource
  next	String	Link to the next page

• Example response

  {
      "links": {
          "self": "https://Endpoint/v2/recordsets?limit=1&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149",
          "next": "https://Endpoint/v2/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/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
      }
  }

Returned Value

If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.

For details, see Status Code.