Перейти к содержимому
Обзор CLI

Обзор CLI

Открыть в Markdown

CLI Status200, status200, управляет вашим проектом Status200 из терминала или скрипта. Она выводит, читает, создаёт, изменяет, удаляет и считает мониторы, инциденты, оповещения, страницы состояния и другие записи, которые предлагает API Status200, с API-ключом вашего проекта.

Как работает CLI

Каждая команда отправляет один запрос к REST API Status200 и выводит ответ. API-ключ и адрес вашего Status200 CLI берёт из флагов, переменных окружения или контекста, который сохранила команда status200 login. Ключ решает, что команда может читать и изменять, точно так же, как в API.

flowchart TB T["Ваш терминал<br/>или задание CI"] -->|"status200 incident list"| C["CLI status200"] K["API-ключ и URL:<br/>флаги, окружение<br/>или сохранённый контекст"] --> C C -->|"POST /api/incident/get-list"| A["REST API Status200"] A -->|"записи, которые ключ<br/>может читать, в JSON"| C C -->|"таблица в терминале,<br/>JSON в конвейере"| T

Одна команда, один запрос

Команды для записей входят в CLI: у каждого вида записей, который API Status200 открывает инструментам, есть своя, это те же записи, для которых у сервера MCP есть инструменты. Запустите status200 resources, чтобы вывести их.

Перед началом

  • Node.js и npm актуальной LTS-версии, чтобы установить CLI.
  • API-ключ вашего проекта. Создайте его в Настройки проекта → Расширенный → Ключи API кнопкой Создать: API-ключ: см. Создайте API-ключ.
  • В Status200 Cloud — план Growth или выше. API-ключи проекта работают только на нём: см. API-ключи и SCIM ниже их плана.

Установка CLI

Установите пакет @status200/cli из npm. Он добавляет команду status200, а --version выводит установленную версию:

Bash
npm install -g @status200/cli
status200 --version

CLI выпускается вместе с Status200 и имеет тот же номер версии. В самостоятельно размещённом Status200 установите CLI той же версии, что и ваш Status200, чтобы её команды соответствовали записям вашего сервера:

Bash
npm install -g @status200/cli@<your-oneuptime-version>

Первые команды

  1. Сохраните API-ключ

    Войдите с ключом и адресом вашего Status200. CLI сохраняет их как контекст с именем default и с этого момента использует его:

    Bash
    status200 login <your-api-key> https://status200.ru

    Она отвечает Logged in successfully. Context "default" is now active. В самостоятельно размещённом Status200 используйте его адрес вместо https://status200.ru.

  2. Выведите свои инциденты

    Bash
    status200 incident list

    Десять самых новых инцидентов появляются в виде таблицы. login сохраняет ключ, не проверяя его, поэтому именно эта команда первой показывает, что ключ работает: если его отклонили, см. Устранение неполадок.

  3. Посмотрите, чем ещё можно управлять

    Bash
    status200 resources

    Список показывает каждый вид записей, с которым можно работать, и его команду, например monitor, status-page или on-call-policy.

Команды кратко

КомандаЧто делаетПодробнее
status200 login <api-key> <instance-url>Сохраняет API-ключ и адрес как контекстАутентификация
status200 context list, use, current, deleteВыводит, переключает, показывает и удаляет сохранённые контекстыАутентификация
status200 whoamiПоказывает URL и API-ключ, которые использует следующая командаАутентификация
status200 deployЗаписывает развёртывание или другое изменение для графиков и Status200 AIРазвёртывания и изменения
status200 <resource> list, get, create, update, delete, countРаботает с одним видом записейОперации с ресурсами
status200 resourcesВыводит виды записей с их командамиСправочник команд
status200 versionВыводит версию CLIСправочник команд
status200 help [command]Показывает справку по командеПолучение справки

Глобальные параметры

Эти параметры работают с любой командой, до неё или после:

ПараметрЧто делает
--api-key <key>API-ключ для этой команды вместо сохранённого
--url <url>Адрес вашего Status200 для этой команды
--context <name>Сохранённый контекст для этой команды вместо текущего
-o, --output <format>table, json или wide: см. Форматы вывода
--no-colorВыводит без цветов
-V, --versionВыводит версию CLI
-h, --helpПоказывает справку по команде

Получение справки

У каждой команды есть своя справка с её аргументами, параметрами и значениями по умолчанию:

Bash
status200 --help
status200 help incident
status200 incident list --help

Дальнейшие шаги