Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud DNS
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GetRecordSet
        • ListRecordSets
        • UpdateRecordSets
        • UpsertRecordSets
        • ListOperations
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
        • UpdatePrivateNetworks
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • ListDnsZoneRecordSetsRequest
  • ListDnsZoneRecordSetsResponse
  • RecordSet
  1. API reference
  2. gRPC
  3. DnsZone
  4. ListRecordSets

Cloud DNS API, gRPC: DnsZoneService.ListRecordSets

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • ListDnsZoneRecordSetsRequest
  • ListDnsZoneRecordSetsResponse
  • RecordSet

Retrieves the list of record sets in the specified folder.

gRPC request

rpc ListRecordSets (ListDnsZoneRecordSetsRequest) returns (ListDnsZoneRecordSetsResponse)

ListDnsZoneRecordSetsRequest

{
  "dns_zone_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

dns_zone_id

string

ID of the DNS zone to list record sets in.

To get a DNS zone ID, make a DnsZoneService.List request.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListDnsZoneRecordSetsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListDnsZoneRecordSetsResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters record sets listed in the response. The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].

Each condition has the form <field> <operator> <value>, where:

  1. <field> is the field name. Currently you can use filtering only on the RecordSet.name and RecordSet.type fields.
  2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
  3. <value> represents a value.
    3.1. In case of single value condition (= or !=), the value is a string in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).
    3.2. In case of a list of values condition (IN or NOT IN), the value is (<string1>, <string2>, .., <stringN>), where <string> is a string in double (") or single (') quotes.

Examples of a filter: name="my-record-set", type IN ("MX","A") AND name="works.on.my.machine.".

ListDnsZoneRecordSetsResponse

{
  "record_sets": [
    {
      "name": "string",
      "type": "string",
      "ttl": "int64",
      "data": [
        "string"
      ]
    }
  ],
  "next_page_token": "string"
}

Field

Description

record_sets[]

RecordSet

List of record sets in the specified DNS zone.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListDnsZoneRecordSetsRequest.page_size, use next_page_token as the value
for the ListDnsZoneRecordSetsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

RecordSet

A record set. For details about the concept, see Resource record.

Field

Description

name

string

Domain name.

type

string

Record type.

ttl

int64

Time to live in seconds.

data[]

string

Data of the record set.

Was the article helpful?

Previous
GetRecordSet
Next
UpdateRecordSets
© 2025 Direct Cursus Technology L.L.C.