Cloud DNS API, REST: DnsZone.list
Retrieves the list of DNS zones in the specified folder.
HTTP request
GET https://dns.api.cloud.yandex.net/dns/v1/zones
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list DNS zones in. To get the folder ID use a list request. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 1000. |
filter | A filter expression that filters DNS zones listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"dnsZones": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": {},
"deletionProtection": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
dnsZones[] | object List of DNS zones in the specified folder. |
dnsZones[]. id |
string ID of the DNS zone. Generated at creation time. |
dnsZones[]. folderId |
string ID of the folder that the DNS zone belongs to. |
dnsZones[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from 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). |
dnsZones[]. name |
string Name of the DNS zone. The name is unique within the folder. |
dnsZones[]. description |
string Description of the DNS zone. |
dnsZones[]. labels |
object DNS zone labels as |
dnsZones[]. zone |
string DNS zone suffix. |
dnsZones[]. privateVisibility |
object Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only. Configuration for privately visible zones. |
dnsZones[]. privateVisibility. networkIds[] |
string Network IDs. The number of elements must be in the range 0-100. The string length in characters for each value must be equal to 20. |
dnsZones[]. publicVisibility |
object Publicly visible zone settings. Indicates whether records within the zone are publicly visible. Configuration for publicly visible zones. |
dnsZones[]. deletionProtection |
boolean (boolean) Prevents accidental zone removal. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |