Querying Record Sets in a Zone

Function

This API is used to query the record set information, including the name, ID, status, domain name, record value, tag, TTL, creation time, modification time, and description.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/zones/{zone_id}/recordsets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Definition Zone ID Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Definition The resource ID from which the next page of data should begin in pagination query. When querying the first page, leave this parameter empty. When querying the next page, set this parameter to the ID of the last resource on the previous page. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition The number of records returned on each page during pagination query. Constraints N/A Range 0 to 500 Default Value 500
offset	No	Integer	Definition The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data. Constraints If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect. Range 0 to 2147483647 Default Value 0
line_id	No	String	Definition Resolution line ID Constraints N/A Range N/A Default Value N/A
tags	No	String	Definition The tags of the record set, including the tag keys and tag values. Format: key1,value1\|key2,value2. Constraints Multiple tags are separated by vertical bars (\|). The key and value of each tag are separated by a comma (,). The AND operator is used to filter tags. An exact match will be used. - If the tag value starts with &ast, fuzzy matching will work for the string following &ast. Range A maximum of 20 tags can be queried. Default Value N/A
status	No	String	Definition The status of the record set. Constraints N/A Range ACTIVE: The zone is normal. PENDING_CREATE: The zone is being created. PENDING_UPDATE: The zone is being updated. PENDING_DELETE: The zone is being deleted. PENDING_FREEZE: The zone is being frozen. FREEZE: The zone is frozen. ILLEGAL: The zone is frozen due to abuse. POLICE: The zone is frozen due to security reasons. PENDING_DISABLE: The zone is being disabled. DISABLE: The zone is disabled. ERROR: The zone is failed. Default Value N/A
type	No	String	Definition Record set type Constraints N/A Range Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA. Default Value N/A
name	No	String	Definition Name of the record set to be queried. A fuzzy search will be used by default. Constraints N/A Range N/A Default Value N/A
id	No	String	Definition ID of the record set to be queried Constraints N/A Range N/A Default Value N/A
sort_key	No	String	Definition The sorting field of record set query results. Constraints N/A Range name: record set name type: record set type created_at: creation time updated_at: update time Default Value created_at
sort_dir	No	String	Definition The sorting method of record set query results. Constraints N/A Range desc: descending order asc: ascending order Default Value desc
search_mode	No	String	Definition Search mode Constraints N/A Range like: fuzzy search equal: exact search Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
recordsets	Array of ShowRecordSetByZoneResp objects	Definition Record set list Range N/A
metadata	metadata object	Definition Number of resources that meet the filter condition Range N/A

**Table 5** ShowRecordSetByZoneResp
Parameter	Type	Description
id	String	Definition Record set ID Range N/A
name	String	Definition Record set name Range N/A
description	String	Definition The description of the record set. Range The value can contain a maximum of 255 characters.
zone_id	String	Definition Zone ID of the record set Range N/A
zone_name	String	Definition Zone name of the record set Range N/A
type	String	Definition Record set type Range Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA.
ttl	Integer	Definition Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. Range 1 to 2147483647
records	Array of strings	Definition Record set value Range N/A
created_at	String	Definition The time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
updated_at	String	Definition The time when the record set was last modified. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
status	String	Definition The status of the record set. Range ACTIVE: The zone is normal. PENDING_CREATE: The zone is being created. PENDING_UPDATE: The zone is being updated. PENDING_DELETE: The zone is being deleted. PENDING_FREEZE: The zone is being frozen. FREEZE: The zone is frozen. ILLEGAL: The zone is frozen due to abuse. POLICE: The zone is frozen due to security reasons. PENDING_DISABLE: The zone is being disabled. DISABLE: The zone is disabled. ERROR: The zone is failed.
default	Boolean	Definition Whether the record set is created by default. A default record set cannot be deleted. Range N/A
project_id	String	Definition ID of the project to which the record set belongs Range N/A
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
line	String	Definition Resolution line ID Range N/A
weight	Integer	Definition Weight of the record set Range 0 to 1000
health_check_id	String	Definition Health check ID Range N/A
alias_target	alias_target object	Definition Domain name alias Constraints N/A Range N/A Default Value N/A

**Table 6** pageLink
Parameter	Type	Description
self	String	Definition The link to the current page. Range N/A
next	String	Definition The link to the next page. Range N/A

**Table 7** alias_target
Parameter	Type	Description
resource_type	String	Definition Services that support domain name aliases Constraints N/A Range cloudsite: Enterprise Web Portal (EWP) waf: Web Application Firewall (WAF) Default Value N/A
resource_domain_name	String	Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A

**Table 8** metadata
Parameter	Type	Description
total_count	Integer	Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A

Example Requests

Querying record sets in a zone

GET https://{endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=&name=&status=

Example Responses

Status code: 200

Successful request

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=&name=&status=",
    "next" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status="
  },
  "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.",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_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.",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_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.",
    "created_at" : "2016-11-17T12:03:17.827",
    "updated_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
  }
}