Help Center/ Domain Name Service/ API Reference/ APIs/ Record Set Management (v2.1)/ Querying Record Sets in a Zone

Updated on 2026-09-28 GMT+08:00

Querying Record Sets in a Zone

Function

This API is used to query information about all record sets in a specified zone. The information includes the domain name, ID, status, zone, record value, tags, TTL, creation time, modification time, and description.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dns:recordset:list	List	zone *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Definition Zone ID. You can obtain the ID by calling the API for querying public zones (ListPublicZones) or for querying private zones (ListPrivateZones). 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. You can obtain the value from the ID of the last resource in the query result on the previous page. 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. For details about how to obtain the line ID, see Resolution Lines. Alternatively, you can obtain the line ID by calling the API for querying custom lines (ListCustomLine) or the API for querying the line groups (ListLineGroups). 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. The value is a string. Multiple tags are represented in the format of key1,value1\|key2,value2. Each tag contains a key (mandatory) and a value (optional). Tags are used to manage and filter resources. 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. A maximum of 20 tags can be queried. Range N/A 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 failed to be created. Default Value N/A
type	No	String	Definition Record set type. Constraints N/A Range A: maps a domain name to specified IPv4 addresses. AAAA: maps a domain name to specified IPv6 addresses. MX: maps domain names to email servers. CNAME: maps one domain name to another domain name or multiple domain names to one domain name. TXT: stores text-based information associated with a domain name. SRV: records the services provided by servers. NS: specifies the authoritative DNS server of a domain name. SOA: provides basic information about domain names and details about authoritative servers. CAA: specifies the CA that issues HTTPS certificates for a domain name to prevent incorrect certificate issuing. It only applies to public domain name resolution. PTR: maps an IP address back to a domain name. It only applies to private domain name resolution. 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. You can obtain the IDs by calling the API (ShowRecordSetByZone) for querying the record sets of a zone. 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 User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls. You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, see Obtaining 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 Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.
recordsets	Array of ShowRecordSetByZoneResp objects	Definition Record set list. This field is an array. Each element contains fields such as the record set ID, name, type, TTL, and record value list.
metadata	metadata object	Definition Metadata information about the pagination query, including the total number of resources (total_count) that meet the query conditions.

**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 A: maps a domain name to specified IPv4 addresses. AAAA: maps a domain name to specified IPv6 addresses. MX: maps domain names to email servers. CNAME: maps one domain name to another domain name or multiple domain names to one domain name. TXT: stores text-based information associated with a domain name. SRV: records the services provided by servers. NS: specifies the authoritative DNS server of a domain name. SOA: provides basic information about domain names and details about authoritative servers. CAA: specifies the CA that issues HTTPS certificates for a domain name to prevent incorrect certificate issuing. It only applies to public domain name resolution. PTR: maps an IP address back to a domain name. It only applies to private domain name resolution.
ttl	Integer	Definition Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update will be applied. Range 1 to 2147483647
records	Array of strings	Definition Record set value. This field is a string array. Each element is the value of a record set.
created_at	String	Definition The time when the record set was created. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. Range N/A
updated_at	String	Definition The time when the record set was last modified. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. 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 failed to be created.
default	Boolean	Definition Whether the record set is created by default. A default record set cannot be deleted. Range true: The record set is generated by the system by default and cannot be deleted. false: The record set is not generated by the system by default and can be deleted.
project_id	String	Definition ID of the project to which the record set belongs Range N/A
links	pageLink object	Definition Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.
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, which is used to point the current record set to the domain name of another cloud service.

**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 Service that supports domain name aliases. Range cloudsite: Enterprise Web Portal (EWP) waf: Web Application Firewall (WAF)
resource_domain_name	String	Definition Domain name of the target service. Range 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

{
  "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
  }
}

SDK Sample Code

The SDK sample code is as follows.

     package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class ShowRecordSetByZoneSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowRecordSetByZoneRequest request = new ShowRecordSetByZoneRequest();
        request.withZoneId("{zone_id}");
        try {
            ShowRecordSetByZoneResponse response = client.showRecordSetByZone(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 
 
  

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowRecordSetByZoneRequest()
        request.zone_id = "{zone_id}"
        response = client.show_record_set_by_zone(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dns.DnsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dns.NewDnsClient(hcClient)

    request := &model.ShowRecordSetByZoneRequest{}
	request.ZoneId = "{zone_id}"
	response, err := client.ShowRecordSetByZone(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	Successful request

Error Codes

See Error Codes.

Parent Topic: Record Set Management (v2.1)

Previous topic: Creating a Record Set

Next topic: Querying Record Sets