Связаться с намиПодключиться
Yandex Cloud DNS

Cloud DNS API, REST: DnsZone.list

Статья создана
Обновлена 12 марта 2024 г.

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

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 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).
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 key:value pairs.
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 next_page_token as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.
Предыдущая
getRecordSet
Следующая
listAccessBindings
В этой статье: