CLI
CLI — это инструмент для централизованного выполнения команд в JSON-формате на заданных объектах.
Инструмент позволяет:
выполнять запросы на нескольких объектах,
отслеживать их статус,
анализировать ответы по каждому объекту,
повторно выполнять неуспешные запросы,
сохранять запросы в виде шаблонов,
работать с шаблонами и использовать их повторно.
Начало работы с CLI
выберите пункт CLI в боковом меню интерфейса;
либо на странице Объекты выберите один или несколько объектов и нажмите опцию CLI в контекстном меню или в меню групповых операций.
1. Редактор запроса
1.1 Создание нового запроса
Для создания CLI-запроса нажмите Новый запрос.
CLI поддерживает три типа запросов:
GET
POST
DELETE
Тип запроса выбирается с помощью табов в верхней части формы.
Запрос может быть задан одним из двух способов:
JSON-формат
Пользователь вводит тело запроса в редакторе в JSON-формате. Доступны функции форматирования и редактирования.
URL-команда
Пользователь вводит команду в поле URL после префикса. Например:
show/mws/member
Далее нажмите Выбрать объекты. Откроется модальное окно выбора объектов, отметьте чекбоксами объекты, на которых необходимо выполнить запрос и нажмите Продолжить.
На следующем шаге убедитесь, что список объектов верный и нажмите Подтвердить.
Для отправки команды в форме создания запроса нажмите Выполнить.
Отправленный запрос отображается в Истории и более недоступен для редактирования.
1.2 Статусы запросов
Каждый запрос может иметь один или несколько статусов (в зависимости от количества выбранных объектов):
Черновик — запрос не был отправлен и не сохранен в истории.
Выполняется — запрос выполняется.
Успех — запрос успешно выполнен на объекте.
Ошибка — выполнение запроса завершилось ошибкой.
1.3 Просмотр ответа
Для просмотра ответа по каждому объекту, рядом с полем ответа в выпадающем списке выберете нужный объект. Для каждого объекта отображается:
тело ответа;
либо текст ошибки, если тело ответа отсутствует.
1.4 Сохранение запроса в шаблон
Текущий запрос можно сохранить как шаблон:
Нажмите кнопку Сохранить как шаблон.
Запрос будет сохранён в разделе Шаблоны и доступен для повторного использования.
1.5 Повторить для неудачных
Кнопка Повторить для неудачных позволяет повторно выполнить запрос только для объектов, по которым был получен статус Ошибка.
2. История
Раздел История предназначен для просмотра и управления ранее выполненными CLI-запросами. Он позволяет отслеживать статус выполнения запросов, анализировать результаты и ошибки, а также повторно выполнять неуспешные запросы. Записи из истории не удаляются.
Для целей аудита и командной работы в Журнал событий автоматически записываются следующие события:
отправка CLI-запроса;
завершение выполнения CLI-запроса (успешно или с ошибкой).
3. Шаблоны
Шаблоны используются для сохранения часто выполняемых запросов с целью их повторного использования без необходимости повторного ввода параметров. Они позволяют ускорить выполнение операций и снизить вероятность ошибок при работе с CLI.
3.1 Создание нового шаблона
Шаблон может быть создан:
вручную в разделе Шаблоны с помощью кнопки Создать шаблон;
либо из открытого запроса в разделе История с помощью кнопки Сохранить как шаблон.
Доступны следующие действия:
Выполнение запроса из шаблона
Дублирование шаблона
Переименование шаблона
Редактирование и сохранение шаблона
Удаление шаблона
3.2 Выполнение запроса из шаблона
Пожалуйста, проверьте корректность списка выбранных объектов перед выполнением запроса. При нажатии кнопки Выполнить, из открытого шаблона формируется Запрос, который отображается в разделе История.
4. Командная работа и роли пользователей
Пользователи с ролями Владельца, Администратора, Менеджера и Наблюдателя могут выполнять CLI-команды на объектах Владельца. Внутри контроллера применяются ограничения в зависимости от роли участника команды.