Cloud DNS API, gRPC: DnsZoneService.List
Retrieves the list of DNS zones in the specified folder.
gRPC request
rpc List (ListDnsZonesRequest) returns (ListDnsZonesResponse)
ListDnsZonesRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
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. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters DNS zones listed in the response. The expression must specify:
|
ListDnsZonesResponse
{
"dnsZones": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": "PublicVisibility",
"deletionProtection": "bool"
}
],
"nextPageToken": "string"
}
Field |
Description |
dnsZones[] |
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 Each subsequent page will have its own |
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. |
folderId |
string ID of the folder that the DNS zone belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the DNS zone. |
description |
string Description of the DNS zone. |
labels |
string DNS zone labels as |
zone |
string DNS zone suffix. |
privateVisibility |
Privately visible zone settings. |
publicVisibility |
Publicly visible zone settings. |
deletionProtection |
bool Prevents accidental zone removal. |
PrivateVisibility
Configuration for privately visible zones.
Field |
Description |
networkIds[] |
string Network IDs. |
PublicVisibility
Configuration for publicly visible zones.
Field |
Description |
Empty |