Метод create

Создает кластер ClickHouse в указанной папке.

HTTP-запрос

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters

Параметры в теле запроса

 {
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "clickhouse": {
      "config": {
        "logLevel": "string",
        "mergeTree": {
          "replicatedDeduplicationWindow": "integer",
          "replicatedDeduplicationWindowSeconds": "integer"
        },
        "compression": [
          {
            "method": "string",
            "minPartSize": "string",
            "minPartSizeRatio": "number"
          }
        ],
        "dictionaries": [
          {
            "name": "string",
            "structure": {
              "id": {
                "name": "string"
              },
              "key": {
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "attributes": [
                {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                }
              ]
            },
            "layout": {
              "type": "string",
              "sizeInCells": "string"
            },

            // `configSpec.clickhouse.config.dictionaries[]`включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`
            "fixedLifetime": "string",
            "lifetimeRange": {
              "min": "string",
              "max": "string"
            },
            // конец списка возможных полей`configSpec.clickhouse.config.dictionaries[]`

            "httpSource": {
              "url": "string",
              "format": "string"
            },
            "mysqlSource": {
              "db": "string",
              "table": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "replicas": [
                {
                  "host": "string",
                  "priority": "string",
                  "port": "string",
                  "user": "string",
                  "password": "string"
                }
              ],
              "where": "string",
              "invalidateQuery": "string"
            },
            "clickhouseSource": {
              "db": "string",
              "table": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "where": "string"
            },
            "mongodbSource": {
              "db": "string",
              "collection": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string"
            }
          }
        ],
        "graphiteRollup": [
          {
            "name": "string",
            "patterns": [
              {
                "regexp": "string",
                "function": "string",
                "retention": [
                  {
                    "age": "string",
                    "precision": "string"
                  }
                ]
              }
            ]
          }
        ],
        "maxConnections": "integer",
        "maxConcurrentQueries": "integer",
        "keepAliveTimeout": "integer",
        "uncompressedCacheSize": "integer",
        "markCacheSize": "integer",
        "maxTableSizeToDrop": "integer",
        "builtinDictionariesReloadInterval": "integer"
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    }
  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "name": "string",
      "password": "string",
      "permissions": [
        {
          "databaseName": "string"
        }
      ]
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "type": "string",
      "subnetId": "string",
      "assignPublicIp": true
    }
  ],
  "networkId": "string"
}
Поле Описание
folderId string

Обязательное поле. Идентификатор каталога, в котором нужно создать кластер ClickHouse.

Максимальная длина строки в символах — 50.

name string

Обязательное поле. Имя кластера ClickHouse. Имя должно быть уникальным в рамках каталога.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

description string

Описание кластера ClickHouse.

Максимальная длина строки в символах — 256.

labels object

Пользовательские метки для кластера ClickHouse как пары ключ:значение. Maximum 64 per resource. For example, `project": "mvp" или "source": "dictionary".

Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z].

environment string

Обязательное поле. Среда развертывания кластера ClickHouse.

Среда развертывания.

  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
configSpec object

Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера ClickHouse.

configSpec.
clickhouse
object

Конфигурация и ресурсы для сервера ClickHouse.

configSpec.
clickhouse.
config
object

Конфигурация для сервера ClickHouse.

Настройки конфигурации ClickHouse. Подробное описание для каждого набора настроек доступно в документации ClickHouse.

Любые настройки, не перечисленные здесь, не поддерживаются.

configSpec.
clickhouse.
config.
logLevel
string

Уровень логирования для кластера ClickHouse.

configSpec.
clickhouse.
config.
mergeTree
object

Параметры движка MergeTree. См. описание в документации ClickHouse.

Настройки движка таблицы MergeTree.

configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Количество блоков хэшей, которые должен хранить ZooKeeper. См. описание в ClickHouse sources.

configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Период времени, в течение которого следует хранить блоки хэшей. См. описание в ClickHouse sources.

configSpec.
clickhouse.
config.
compression[]
object

Параметры сжатия для кластера ClickHouse. См. подробное описание в документации ClickHouse.

configSpec.
clickhouse.
config.
compression[].
method
string

Метод сжатия, используемый для указанной комбинации min_part_size и min_part_size_ratio.

configSpec.
clickhouse.
config.
compression[].
minPartSize
string (int64)

Минимальный размер части таблицы.

Минимальное значение — 1.

configSpec.
clickhouse.
config.
compression[].
minPartSizeRatio
number (double)

Минимальное отношение части к размеру всех данных в таблице.

configSpec.
clickhouse.
config.
dictionaries[]
object

Конфигурация внешних словарей для кластера ClickHouse. См. подробное описание в документации ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
name
string

Обязательное поле. Имя внешнего словаря.

configSpec.
clickhouse.
config.
dictionaries[].
structure
object
configSpec.
clickhouse.
config.
dictionaries[].
structure.
id
object

Один столбец с числовыми ключами для словаря.

Числовой ключ.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
id.
name
string

Обязательное поле. Имя числового ключа.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key
object

Составной ключ для словаря, содержащего один или несколько столбцов с ключами.

Составной ключ.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[]
object

Обязательное поле. Поля составного ключа.

Должен содержать хотя бы один элемент.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
name
string

Обязательное поле. Имя столбца.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
type
string

Обязательное поле. Тип столбца.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию: "false".

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию: "false".

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[]
object

Обязательное поле. Описание полей, доступных для запросов к базе данных.

Должен содержать хотя бы один элемент.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
name
string

Обязательное поле. Имя столбца.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
type
string

Обязательное поле. Тип столбца.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
nullValue
string

Значение по умолчанию для элемента без данных (например, пустая строка).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
expression
string

Выражение, описывающее атрибут, если применимо.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Признак поддержки иерархии. Значение по умолчанию: "false".

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Признакт инъективного отображения "id -> атрибут". Значение по умолчанию: "false".

configSpec.
clickhouse.
config.
dictionaries[].
layout
object

Макет, определяющий способ хранения словаря в памяти.

configSpec.
clickhouse.
config.
dictionaries[].
layout.
type
string

Обязательное поле. Тип макета для внешнего словаря.

  • FLAT: Весь словарь хранится в памяти в виде плоских массивов. Доступно для любых источников словарей.
  • HASHED: Весь словарь хранится в памяти в виде хэш-таблицы. Доступно для любых источников словарей.
  • COMPLEX_KEY_HASHED: Аналогичен HASHED, для использования с составными ключами. Доступно для любых источников словарей.
  • RANGE_HASHED: Весь словарь хранится в памяти в виде хэш-таблицы, с упорядоченным массивом диапазонов и соответствующих им значений. Доступно для любых источников словарей.
  • CACHE: Словарь хранится в кэше с заданным количеством ячеек. Доступно для источников словарей MySQL, ClickHouse и HTTP.
  • COMPLEX_KEY_CACHE: Аналогичен CACHE, для использования с составными ключами. Доступно для источников словарей MySQL, ClickHouse и HTTP.
configSpec.
clickhouse.
config.
dictionaries[].
layout.
sizeInCells
string (int64)

Количество ячеек в кэше. Округляется до степени двойки. Применимо только для типов макета CACHE и COMPLEX_KEY_CACHE.

configSpec.
clickhouse.
config.
dictionaries[].
fixedLifetime
string (int64)
configSpec.clickhouse.config.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

Жесткий интервал между обновлениями словаря.

configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange
object
configSpec.clickhouse.config.dictionaries[] включает только одно из полей fixedLifetime, lifetimeRange

configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
min
string (int64)

Минимальное время жизни словаря.

configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
max
string (int64)

Максимальное время жизни словаря.

configSpec.
clickhouse.
config.
dictionaries[].
httpSource
object
configSpec.clickhouse.config.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource

configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
url
string

Обязательное поле. URL внешнего словаря, доступного по HTTP.

configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
format
string

Обязательное поле. Формат данных. Допустимые значения: все форматы, поддерживаемые диалектом ClickHouse SQL.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource
object
configSpec.clickhouse.config.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
db
string

Обязательное поле. Имя базы данных MySQL, к которой нужно подключаться.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
table
string

Обязательное поле. Имя таблицы базы данных, которую следует использовать в качестве словаря ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
port
string (int64)

Порт по умолчанию, который нужно использовать при подключении к реплике источника словаря.

Допустимые значения — от 0 до 65535 включительно.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
user
string

Имя пользователя по умолчанию для реплик источника словаря.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
password
string

Пароль пользователя по умолчанию для реплик источника словаря.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[]
object

Обязательное поле. Список реплик базы данных MySQL, используемой в качестве источника словаря.

Должен содержать хотя бы один элемент.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
host
string

Обязательное поле. Хост реплики MySQL.

Максимальная длина строки в символах — 253.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Обязательное поле. Приоритет реплики, который ClickHouse должен учитывать при подключении. Реплике с наивысшим приоритетом должно соответствовать наименьшее значение в этом поле.

Значение должно быть больше 0.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Порт, который нужно использовать при подключении к реплике. Если для какой-либо реплики не указан порт, ClickHouse использует порт, указанный для источника.

Допустимые значения — от 0 до 65535 включительно.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
user
string

Имя пользователя базы данных MySQL.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
password
string

Пароль пользователя базы данных MySQL.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
where
string

Критерии выбора данных в указанной таблице MySQL.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
invalidateQuery
string

Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse о словарях.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource
object
configSpec.clickhouse.config.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
db
string

Обязательное поле. Имя базы данных ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
table
string

Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
host
string

Обязательное поле. Хост ClickHouse для указанной базы данных.

Максимальная длина строки в символах — 253.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
user
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
password
string

Пароль пользователя базы данных ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
where
string

Критерии выбора данных в указанной таблице ClickHouse.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource
object
configSpec.clickhouse.config.dictionaries[] включает только одно из полей httpSource, mysqlSource, clickhouseSource, mongodbSource

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
db
string

Обязательное поле. Имя базы данных MongoDB.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
collection
string

Обязательное поле. Имя коллекции в указанной базе данных, которую следует использовать в качестве источника словаря.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
host
string

Обязательное поле. Хост MongoDB для указанной базы данных.

Максимальная длина строки в символах — 253.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
port
string (int64)

Порт для подключения к хосту.

Допустимые значения — от 0 до 65535 включительно.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
user
string

Обязательное поле. Имя пользователя базы данных MongoDB.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
password
string

Пароль пользователя базы данных MongoDB.

configSpec.
clickhouse.
config.
graphiteRollup[]
object

Параметры свертки для движка таблицы GraphiteMergeTree.

configSpec.
clickhouse.
config.
graphiteRollup[].
name
string

Обязательное поле. Имя указанной комбинации параметров для свертки Graphite.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[]
object

Обязательное поле. Шаблон, используемый для свертки.

Должен содержать хотя бы один элемент.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
regexp
string

Шаблон для имен метрик.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
function
string

Обязательное поле. Имя агрегирующей функции, которую следует применить к данным старше возраста, указанного в retention.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[]
object

Обязательное поле. Возраст данных, которые следует использовать для прореживания.

Должен содержать хотя бы один элемент.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Минимальный возраст данных в секундах.

Значение должно быть больше 0.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Точность определения возраста данных, в секундах.

Значение должно быть больше 0.

configSpec.
clickhouse.
config.
maxConnections
integer (int64)

Максимальное количество входящих подключений.

Минимальное значение — 10.

configSpec.
clickhouse.
config.
maxConcurrentQueries
integer (int64)

Максимальное количество одновременно обрабатываемых запросов.

Минимальное значение — 10.

configSpec.
clickhouse.
config.
keepAliveTimeout
integer (int64)

Количество миллисекунд, в течение которых ClickHouse ожидает входящие запросы прежде чем закрыть подключение.

configSpec.
clickhouse.
config.
uncompressedCacheSize
integer (int64)

Размер кэша (в байтах) для несжатых данных, используемых таблицами MergeTree. См. подробное описание в документации ClickHouse.

configSpec.
clickhouse.
config.
markCacheSize
integer (int64)

Примерный размер (в байтах) кэша «меток», используемых таблицами MergeTree. Подробнее в документации ClickHouse.

Значение должно быть больше 5368709120.

configSpec.
clickhouse.
config.
maxTableSizeToDrop
integer (int64)

Максимальный размер таблицы, которую можно удалить с помощью запроса DROP. См. подробное описание в документации ClickHouse.

configSpec.
clickhouse.
config.
builtinDictionariesReloadInterval
integer (int64)

Интервал времени для перезагрузки встроенных словарей. См. подробное описание в документации ClickHouse.

configSpec.
clickhouse.
resources
object

Ресурсы, выделенные хостам ClickHouse.

configSpec.
clickhouse.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации

configSpec.
clickhouse.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

configSpec.
clickhouse.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
configSpec.
zookeeper
object

Конфигурация и ресурсы для сервера ZooKeeper.

configSpec.
zookeeper.
resources
object

Ресурсы, выделенные хостам ZooKeeper.

configSpec.
zookeeper.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации

configSpec.
zookeeper.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

configSpec.
zookeeper.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
databaseSpecs[] object

Обязательное поле. Описания баз данных, которые нужно создать в кластере ClickHouse.

Должен содержать хотя бы один элемент.

databaseSpecs[].
name
string

Обязательное поле. Имя базы данных ClickHouse. Длина 1-63 символов.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

userSpecs[] object

Обязательное поле. Описания пользователей базы данных, которых нужно создать в кластере ClickHouse.

Должен содержать хотя бы один элемент.

userSpecs[].
name
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

userSpecs[].
password
string

Обязательное поле. Пароль пользователя ClickHouse.

Длина строки в символах должна быть от 8 до 128.

userSpecs[].
permissions[]
object

Набор разрешений, которые следует предоставить пользователю.

userSpecs[].
permissions[].
databaseName
string

Имя базы данных, к которой предоставляет доступ разрешение.

hostSpecs[] object

Обязательное поле. Конфигурации для отдельных хостов, которые должны быть созданы для кластера ClickHouse.

Должен содержать хотя бы один элемент.

hostSpecs[].
zoneId
string

Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос list.

Максимальная длина строки в символах — 50.

hostSpecs[].
type
string

Обязательное поле. Тип развертываемого хоста.

  • CLICKHOUSE: Хост ClickHouse.
  • ZOOKEEPER: Хост ZooKeeper.
hostSpecs[].
subnetId
string

Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.networkId.

Максимальная длина строки в символах — 50.

hostSpecs[].
assignPublicIp
boolean (boolean)

Должен ли хост получить публичный IP-адрес при создании.

После создания узла этот параметр изменить нельзя. Чтобы удалить назначенный публичный IP-адрес или назначить публичный IP уже созданному хосту, пересоздайте хост с нужным значением поля assignPublicIp.

Возможные значения:

  • false — не назначать хосту публичный IP-адрес.
  • true — у хоста должен быть публичный IP-адрес.
networkId string

Обязательное поле. Идентификатор сети, в которой нужно создать кластер.

Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

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

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

}

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

Поле Описание
id string

Только для вывода. Идентификатор операции.

description string

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

createdAt string (date-time)

Только для вывода. Время создания ресурса в формате в RFC3339.

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

createdBy string

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

modifiedAt string (date-time)

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

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

done boolean (boolean)

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

metadata object

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

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

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

error.
code
integer (int32)

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

error.
message
string

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

error.
details[]
object

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

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

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