Метод list

HTTP-запрос
Query-параметры
Ответ

Возвращает список зон DNS в указанном каталоге.

HTTP-запрос

GET https://dns.api.cloud.yandex.net/dns/v1/zones

Query-параметры

Параметр	Описание
folderId	Обязательное поле. Идентификатор каталога для получения списка зон DNS. Чтобы получить идентификатор каталога, используйте запрос list.
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем `page_size`, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken	Токен страницы. Установите значение `page_token` равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 1000.
filter	Параметры фильтрации зон DNS в ответе. В параметрах фильтрации указываются: 1. Имя поля. Фильтрация осуществляется только по полю DnsZone.name. 2. Оператор. Поддерживаются операторы `=` и `!=` для одиночных значений, `IN` и `NOT IN` для списков значений. 3. Значение или списки значений. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Пример фильтра: `name=my-dns-zone`. Максимальная длина строки в символах — 1000.

Ответ

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"
}

Поле	Описание
dnsZones[]	object Зона DNS. Подробнее см. в разделе Зоны DNS.
dnsZones[]. id	string Идентификатор зоны DNS. Генерируется при создании.
dnsZones[]. folderId	string Идентификатор каталога, которому принадлежит зона DNS.
dnsZones[]. createdAt	string (date-time) Время создания ресурса. Строка в формате RFC3339.
dnsZones[]. name	string Имя зоны DNS. Имя должно быть уникальным в каталоге.
dnsZones[]. description	string Описание зоны DNS.
dnsZones[]. labels	object Метки зон DNS в формате `key:value`.
dnsZones[]. zone	string Суффикс зоны DNS.
dnsZones[]. privateVisibility	object Настройки внутренней зоны. Указывают, будут ли записи в зоне видны только из сетей VPC. Конфигурация для внутренних зон.
dnsZones[]. privateVisibility. networkIds[]	string Идентификаторы сетей. Количество элементов должно находиться в диапазоне от 0 до 10. Длина строки в символах должна быть равна 20.
dnsZones[]. publicVisibility	object Настройки публичной зоны. Указывают, являются ли записи в пределах зоны публичными. Конфигурация для публичных зон.
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте `next_page_token` в качестве значения параметра pageToken в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой `next_page_token` для продолжения перебора страниц результатов.