Updated on 2025-08-21 GMT+08:00

Querying Record Sets

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/recordsets

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

zone_type

No

String

Definition

Type of the zone to which the record set belongs.

Constraints

N/A

Range

  • public: Public zone record sets are queried.

  • private: Private zone record sets are queried.

Default Value

public

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

zone_id

No

String

Definition

Zone ID

Constraints

N/A

Range

N/A

Default Value

N/A

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

records

No

String

Definition

The value 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

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

health_check_id

No

String

Definition

Health check ID.

A fuzzy search will be used by default.

Constraints

N/A

Range

N/A

Default Value

N/A

search_mode

No

String

Definition

The search mode.

Constraints

N/A

Range

  • like: fuzzy search

  • equal: exact search

Default Value

Name: fuzzy search by default; others: exact search by default

Request Parameters

Table 2 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 3 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 QueryRecordSetWithLineAndTagsResp objects

Definition

Record set list

Range

N/A

metadata

metadata object

Definition

Number of resources that meet the filter condition

Range

N/A

Table 4 QueryRecordSetWithLineAndTagsResp

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

tags

Array of tag objects

Definition

Resource tag

Range

N/A

line

String

Definition

Resolution line ID

Range

N/A

line_name

String

Definition

Resolution line name

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

Range

N/A

Table 6 tag

Parameter

Type

Description

key

String

Definition

The tag key.

Range

  • Cannot be left blank.

  • Must be unique for each resource.

  • Contains up to 128 characters.

  • Cannot start or end with a space, or start with sys. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

value

String

Definition

The tag value.

Range

  • Can be left blank.

  • Can contain a maximum of 255 characters.

  • Only letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

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

GET https://{endpoint}/v2.1/recordsets

Example Responses

Status code: 200

Successful request

{
  "links" : {
    "self" : "https://Endpoint/v2.1/recordsets",
    "next" : "https://Endpoint/v2.1/recordsets?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.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" : "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.1/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"
    },
    "alias_target" : null,
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:56:06.439",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "xxx",
    "weight" : 1,
    "health_check_id" : null
  }, {
    "id" : "2c9eb155587228570158722996ca0004",
    "name" : "example.org.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"
    },
    "alias_target" : null,
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:56:06.439",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "xxx",
    "weight" : 1,
    "health_check_id" : null
  }, {
    "id" : "2c9eb155587228570158722b6ac30007",
    "name" : "www.example.com.",
    "description" : "This is an example record set.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "abc.bcd.com." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "alias_target" : {
      "resource_type" : "cloudsite",
      "resource_domain_name" : "2018122216193840mjysxoqn.cname.ysjianzhan.cn."
    },
    "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" : 5
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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 ListRecordSetsWithLineSolution {

    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();
        ListRecordSetsWithLineRequest request = new ListRecordSetsWithLineRequest();
        try {
            ListRecordSetsWithLineResponse response = client.listRecordSetsWithLine(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 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 = ListRecordSetsWithLineRequest()
        response = client.list_record_sets_with_line(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRecordSetsWithLineRequest{}
	response, err := client.ListRecordSetsWithLine(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.