Описание API для работы с Очередями
Создание новой Очереди (Queue)
Создает новую очередь.
Запрос
Swagger
POST
/createQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
result | object | |
id | string |
Получение Очереди по наименованию
Возвращает объект Очереди, найденной по наименованию.
Запрос
Swagger
POST
/getQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Получение списка Очередей
Возвращает массив объектов — список Очередей, упорядоченный по имени.
Запрос
Swagger
POST
/listQueuesТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
result | object | |
id | string |
Удаление Очереди
Удаляет Очередь с заданным в запросе именем.
Запрос
Swagger
POST
/deleteQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Запуск Очереди
Изменяет статус очереди на `OPEN`, поле `updateTime` принимает значение текущих времени и даты.
Запрос
Swagger
POST
/openQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Завершение Очереди
Изменяет статус очереди на `CLOSE`, поле `updateTime` принимает значение текущих времени и даты.
Запрос
Swagger
POST
/closeQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Обновление Очереди
В случае отсутствия ошибок возвращает измененный объект Очереди.
Запрос
Swagger
POST
/updateQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Поиск Очереди
Возвращает найденную Очередь.
Запрос
Swagger
POST
/searchQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Поиск группы Очередей
Выполняет поиск группы Очередей по наименованию группы.
Запрос
Swagger
POST
/searchQueueLabelsТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Изменение количества задач
Изменяет параметр `rate`, отвечающий за максимально допустимое количество параллельно выполняемых Задач в Очереди.
Запрос
Swagger
POST
/changeQueueRateТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Остановка Очереди
Отменяет автоматический запуск Задач в Очереди.
Запрос
Swagger
POST
/pauseQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
result | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Возобновление Очереди
Возобновляет автоматический запуск Задач в Очереди.
Запрос
Swagger
POST
/resumeQueueТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Модели
CreateQueueRequestBody
CreateQueueResponseBody
GetQueueRequestBody
GetQueueResponseBody
ListQueuesRequestBody
ListQueuesResponseBody
DeleteQueueRequestBody
DeleteQueueResponseBody
OpenQueueRequestBody
OpenQueueResponseBody
CloseQueueRequestBody
CloseQueueResponseBody
UpdateQueueRequestBody
UpdateQueueResponseBody
SearchQueueRequestBody
SearchQueueResponseBody
SearchQueueLabelsRequestBody
SearchQueueLabelsResponseBody
ChangeQueueRateRequestBody
ChangeQueueRateResponseBody
PauseQueueRequestBody
PauseQueueResponseBody
ResumeQueueRequestBody
ResumeQueueResponseBody
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Пакетная обработка задач
Создание, настройка и удаление очередей, заполнение очередей задачами. Просмотр списков созданных очередей и задач в каждой очереди