Method 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 page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 1000. |
| filter | 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. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value or lists of values. 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. |
Response
HTTP Code: 200 - OK
{
"dnsZones": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zone": "string",
"privateVisibility": {
"networkIds": [
"string"
]
},
"publicVisibility": {}
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| dnsZones[] | object A DNS zone. For details about the concept, see DNS zones. |
| 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. |
| 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-10. 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. |
| 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 |