Перейти к основному содержимому
Версия: 2.15 (последняя)

Создание потребителя

Создание нового потребителя.

Тема​

$JS.API.CONSUMER.CREATE.{stream}.{consumer}

Где {stream} — имя потока, а {consumer} — имя потребителя (необязательно).

Запрос​

Запрос к API JetStream $JS.API.CONSUMER.CREATE

stream_namestringобязательно
Имя потока для создания потребителя
configobjectобязательно
Конфигурация потребителя
actionstring
Действие создания потребителя
pedanticboolean
Включает строгий режим, в котором сервер не подставляет значения по умолчанию и не изменяет запрос
По умолчанию:false

Ответ​

Ответ API JetStream $JS.API.CONSUMER.CREATE

Один из следующих вариантов:
Вариант 1 (object)
stream_namestringобязательно
Поток, которому принадлежит потребитель
namestringобязательно
Уникальное имя потребителя: автоматически созданное или имя долговременного потребителя
tsstring<date-time>
Серверное время формирования информации о потребителе
Момент времени в формате RFC3339 с часовым поясом, обычно UTC
configallOf
createdstring<date-time>обязательно
Время создания потребителя
Момент времени в формате RFC3339 с часовым поясом, обычно UTC
deliveredobjectобязательно
Последнее сообщение, доставленное этим потребителем
ack_floorobjectобязательно
Наибольший номер непрерывно подтверждённой последовательности сообщений
num_ack_pendingintegerобязательно
Число сообщений, ожидающих подтверждения
Целое число с разрядностью, зависящей от платформы кластера, до 64 бит
Минимум:0
Максимум:9223372036854776000
num_redeliveredintegerобязательно
Число выполненных повторных доставок
Целое число с разрядностью, зависящей от платформы кластера, до 64 бит
Минимум:0
Максимум:9223372036854776000
num_waitingintegerобязательно
Число pull-потребителей, ожидающих сообщения
Целое число с разрядностью, зависящей от платформы кластера, до 64 бит
Минимум:0
Максимум:9223372036854776000
num_pendingintegerобязательно
Число ещё не прочитанных сообщений потребителя
Беззнаковое 64-битное целое число
Минимум:0
Максимум:18446744073709552000
clusterobject
push_boundboolean
Указывает, подключён ли хотя бы один клиент, получающий сообщения push-потребителя
pausedboolean
Указывает, находится ли потребитель в приостановленном состоянии
pause_remaininginteger
Оставшееся время приостановки
Длительность в наносекундах, знаковое 64-битное целое число
Минимум:0
Максимум:9223372036854776000
priority_groupsobject[]
Состояние приоритетных групп
Вариант 2 (object)
errorobjectобязательно
typeconst: "io.nats.jetstream.api.v1.consumer_create_response"обязательно