Skip to main content

List

Retrieves the list of DNS zones in the specified folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListDnsZonesRequest = cloudApi.dns.dns_zone_service.ListDnsZonesRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.DnsZoneServiceClient);

  const result = await client.list(
    ListDnsZonesRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListDnsZonesRequest​

folderId : string​

ID of the folder to list DNS zones in.

To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : 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.

pageToken : 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:

  1. The field name. Currently you can use filtering only on the DnsZone.name field.
  2. An = operator.
  3. 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​

dnsZones : DnsZone​

List of DNS zones in the specified folder.

nextPageToken : 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.

id : string​

ID of the DNS zone. Generated at creation time.

folderId : string​

ID of the folder that the DNS zone belongs to.

createdAt : 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 : string​

DNS zone labels as key:value pairs.

zone : string​

DNS zone suffix.

privateVisibility : PrivateVisibility​

Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.

publicVisibility : PublicVisibility​

Publicly visible zone settings. Indicates whether records within the zone are publicly visible.

deletionProtection : bool​

Prevents accidental zone removal.

PrivateVisibility​

Configuration for privately visible zones.

networkIds : string​

Network IDs.

PublicVisibility​

Configuration for publicly visible zones.