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 на сайтах Власника. У межах контролера застосовуються обмеження залежно від ролі учасника команди.