Cloud DNS API, REST: DnsZone.List

Field

Description

folderId

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.

The maximum string length in characters is 50.

pageSize

string (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.nextPageToken
that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

pageToken

string

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

The maximum string length in characters is 1000.

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.

The maximum string length in characters is 1000.

Field

Description

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.pageSize, use next_page_token as the value
for the ListDnsZonesRequest.pageToken parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

Field

Description

id

string

ID of the DNS zone. Generated at creation time.

folderId

string

ID of the folder that the DNS zone belongs to.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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.

privateVisibility

PrivateVisibility

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

publicVisibility

object

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

deletionProtection

boolean

Prevents accidental zone removal.

Field

Description

networkIds[]

string

Network IDs.

The number of elements must be in the range 0-100.