Метод update

HTTP-запрос
Path-параметры
Параметры в теле запроса
Ответ

Изменяет указанный топик Kafka.

HTTP-запрос

PATCH https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/topics/{topicName}

Path-параметры

Параметр	Описание
clusterId	Обязательное поле. Идентификатор кластера Apache Kafka®, в котором следует изменить топик. Чтобы получить идентификатор кластера, выполните запрос list. Максимальная длина строки в символах — 50.
topicName	Обязательное поле. Имя топика, который нужно изменить. Чтобы получить имя топика, выполните запрос list. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.

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

{
  "updateMask": "string",
  "topicSpec": {
    "name": "string",
    "partitions": "integer",
    "replicationFactor": "integer",
    "topicConfig_2_1": {
      "cleanupPolicy": "string",
      "compressionType": "string",
      "deleteRetentionMs": "integer",
      "fileDeleteDelayMs": "integer",
      "flushMessages": "integer",
      "flushMs": "integer",
      "minCompactionLagMs": "integer",
      "retentionBytes": "integer",
      "retentionMs": "integer"
    }
  }
}

Поле	Описание
updateMask	string Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре `updateMask` и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0. Если в запросе не передается `updateMask`, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.
topicSpec	object Новые настройки топика. Используйте параметр updateMask чтобы предотвратить сброс настроек топика, не перечисленных в topicSpec, на значения по умолчанию.
topicSpec. name	string Имя топика.
topicSpec. partitions	integer (int64) Количество разделов в топике.
topicSpec. replicationFactor	integer (int64) Количество копий данных топика, хранящихся в кластере.
topicSpec. topicConfig_2_1	object Настройки топика.
topicSpec. topicConfig_2_1. cleanupPolicy	string Политика хранения старых сообщений лога. CLEANUP_POLICY_DELETE: эта политика отбрасывает сегменты лога либо при истечении срока их хранения, либо при достижении предельного размера лога. См. также описание `logRetentionMs` и других подобных параметров. CLEANUP_POLICY_COMPACT: эта политика сжимает сообщения в логе. CLEANUP_POLICY_COMPACT_AND_DELETE: эта политика использует как сжатие сообщений, так и удаление сегментов лога.
topicSpec. topicConfig_2_1. compressionType	string Тип сжатия для указанного топика. COMPRESSION_TYPE_UNCOMPRESSED: не использовать кодек (сообщения не сжимаются). COMPRESSION_TYPE_ZSTD: кодек Zstandard. COMPRESSION_TYPE_LZ4: Кодек LZ4. COMPRESSION_TYPE_SNAPPY: Кодек Snappy. COMPRESSION_TYPE_GZIP: кодек GZip. COMPRESSION_TYPE_PRODUCER: кодек задается на стороне производителя (допустимые кодеки: `ZSTD`, `LZ4`, `GZIP` или `SNAPPY`).
topicSpec. topicConfig_2_1. deleteRetentionMs	integer (int64) Время (в миллисекундах), в течение которого нужно хранить tombstone-маркеры удаления для топиков со сжатым логом.
topicSpec. topicConfig_2_1. fileDeleteDelayMs	integer (int64) Время ожидания перед удалением файла из файловой системы.
topicSpec. topicConfig_2_1. flushMessages	integer (int64) Количество сообщений, которые должны быть накоплены в разделе прежде, чем эти сообщения будут сброшены на диск. Эта настройка переопределяет на уровне топика настройку уровня кластера `logFlushIntervalMessages`.
topicSpec. topicConfig_2_1. flushMs	integer (int64) Максимальное время (в миллисекундах), в течение которого сообщение в любом топике хранится в памяти перед сбросом на диск. Эта настройка переопределяет на уровне топика настройку уровня кластера `logFlushIntervalMs`.
topicSpec. topicConfig_2_1. minCompactionLagMs	integer (int64) Минимальное время в миллисекундах, в течение которого сообщение в логе будет оставаться несжатым.
topicSpec. topicConfig_2_1. retentionBytes	integer (int64) Максимальный размер, до которого может вырасти раздел, прежде чем Kafka начнет отбрасывать старые сегменты лога, если действует настройка `delete` `cleanupPolicy`. Эта настройка полезна, если вам необходимо контролировать размер лога из-за ограниченного дискового пространства. Эта настройка переопределяет на уровне топика настройку уровня кластера `logRetentionBytes`.
topicSpec. topicConfig_2_1. retentionMs	integer (int64) Количество миллисекунд до удаления файла сегмента лога; в течение этого времени Kafka будет хранить файл сегмента лога. Эта настройка переопределяет на уровне топика настройку уровня кластера `logRetentionMs`.

Ответ

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