Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Cloud DNS
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Зоны
      • Создать внутреннюю зону DNS
      • Создать публичную зону DNS
      • Изменить зону DNS
      • Удалить зону DNS
    • Записи
      • Создать запись
      • Изменить запись
      • Удалить запись
  • Концепции
    • Обзор
    • Зоны DNS
    • Ресурсные записи
    • Интеграция с Compute Cloud
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • DnsZoneService
      • OperationService
    • REST
      • Обзор
      • DnsZone
        • Обзор
        • create
        • delete
        • get
        • getRecordSet
        • list
        • listAccessBindings
        • listOperations
        • listRecordSets
        • setAccessBindings
        • update
        • updateAccessBindings
        • updateRecordSets
        • upsertRecordSets
  1. Справочник API
  2. REST
  3. DnsZone
  4. listOperations

Метод listOperations

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

Возвращает список операций для указанной зоны DNS.

HTTP-запрос

GET https://dns.api.cloud.yandex.net/dns/v1/zones/{dnsZoneId}/operations

Path-параметры

Параметр Описание
dnsZoneId Идентификатор зоны DNS, для которой запрашивается список операций. Чтобы получить идентификатор зоны DNS, выполните запрос list. Длина строки в символах должна быть равна 20.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
pageToken Токен страницы. Установите значение pageToken равным значению поля 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

{
  "operations": [
    {
      "id": "string",
      "description": "string",
      "createdAt": "string",
      "createdBy": "string",
      "modifiedAt": "string",
      "done": true,
      "metadata": "object",

      // `operations[]` включает только одно из полей `error`, `response`
      "error": {
        "code": "integer",
        "message": "string",
        "details": [
          "object"
        ]
      },
      "response": "object",
      // конец списка возможных полей`operations[]`

    }
  ],
  "nextPageToken": "string"
}
Поле Описание
operations[] object

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

operations[].
id
string

Идентификатор операции.

operations[].
description
string

Описание операции. Длина описания должна быть от 0 до 256 символов.

operations[].
createdAt
string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.

operations[].
createdBy
string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

operations[].
modifiedAt
string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.

operations[].
done
boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

operations[].
metadata
object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

operations[].
error
object
Описание ошибки в случае сбоя или отмены операции.
operations[] включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.

operations[].
error.
code
integer (int32)

Код ошибки. Значение из списка google.rpc.Code.

operations[].
error.
message
string

Текст ошибки.

operations[].
error.
details[]
object

Список сообщений с подробными сведениями об ошибке.

operations[].
response
object
operations[] включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте next_page_token в качестве значения параметра pageToken в следующем запросе списка ресурсов.

Каждая следующая страница будет иметь свой next_page_token для продолжения перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ
Language / Region
Вакансии
Политика конфиденциальности
Условия использования
Брендбук
© 2021 ООО «Яндекс.Облако»