Cloud DNS API, gRPC: DnsZoneService.List

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
ListDnsZonesRequest
ListDnsZonesResponse
DnsZone
PrivateVisibility
PublicVisibility

Retrieves the list of DNS zones in the specified folder.

gRPC request

rpc List (ListDnsZonesRequest) returns (ListDnsZonesResponse)

ListDnsZonesRequest

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

Field	Description
folder_id	string Required field. ID of the folder to list DNS zones in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.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 ListDnsZonesResponse.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 ListDnsZonesResponse.next_page_token returned by a previous list request.
filter	string A filter expression that filters DNS zones listed in the response. The expression must specify: The field name. Currently you can use filtering only on the DnsZone.name field. An `=` operator. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `name=my-dns-zone`.

ListDnsZonesResponse

{
  "dns_zones": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "zone": "string",
      "private_visibility": {
        "network_ids": [
          "string"
        ]
      },
      "public_visibility": "PublicVisibility",
      "deletion_protection": "bool"
    }
  ],
  "next_page_token": "string"
}

Field

Description

dns_zones[]

DnsZone

List of DNS zones in the specified folder.

next_page_token

string

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

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

DnsZone

A DNS zone. For details about the concept, see DNS zones.

Field	Description
id	string ID of the DNS zone. Generated at creation time.
folder_id	string ID of the folder that the DNS zone belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the DNS zone. The name is unique within the folder.
description	string Description of the DNS zone.
labels	object (map<string, string>) DNS zone labels as `key:value` pairs.
zone	string DNS zone suffix.
private_visibility	PrivateVisibility Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.
public_visibility	PublicVisibility Publicly visible zone settings. Indicates whether records within the zone are publicly visible.
deletion_protection	bool Prevents accidental zone removal.

PrivateVisibility

Configuration for privately visible zones.

Field

Description

network_ids[]

string

Network IDs.

PublicVisibility

Configuration for publicly visible zones.

Field	Description
Empty