1. Главная
  2. Хаб
  3. Сценарии
  4. Инвентаризация проекта через API: отчёт о машинах, дисках и адресах по расписанию

Сценарий 20

Инвентаризация проекта через API: отчёт о машинах, дисках и адресах по расписанию

Одной командой h3 собираем список всего, что есть в проекте (машины, диски, базы, адреса, кластеры, бакеты), и складываем в отчёт. Для отчёта заводим отдельный ключ на нужные проекты с коротким сроком, а скрипт делает только GET-запросы.

20 минНовичок5 шагов Серверы, Сети, S3, Цены обновлено

Содержание
  1. 01Создайте отдельный ключ для отчёта
  2. 02Установите CLI и проверьте ключ
  3. 03Напишите скрипт отчёта
  4. 04Найдите свободные адреса
  5. 05Поставьте отчёт в расписание
  6. Проверка результата
  7. Как удалить ресурсы
  8. Типичные ошибки

Что получится

Скрипт inventory-report.sh, который раз в сутки сохраняет JSON-снимок ресурсов проекта и печатает короткую сводку: какие машины работают, какие диски ни к чему не подключены и какие IP-адреса свободны, но оплачиваются.

Что понадобится

  • Проект с ресурсами и право создавать API-ключи (вы участник проекта).
  • Linux-сервер или ноутбук с jq; для расписания — cron.
  1. Шаг 1. Создайте отдельный ключ для отчёта

    Не используйте для отчётов ключ Terraform или CI. Отдельный ключ отзывается, не ломая деплой, а в списке ключей видно, когда им пользовались.

    Консоль

    1. Значок ключа «API и SSH ключи» внизу левой панели → вкладка API-ключи → Добавить ключ → Добавить API-ключ.
    2. Имя ключа inventory, Проекты — только те, что входят в отчёт, Описание — ежедневный отчёт, только GET, Срок действия — «90 дней».
    3. Нажмите Создать API ключ и сохраните секрет из окна «Ключ создан». ID ключа — в списке, строка «ID:».

    Если не получилось

    • Ключ, созданный в консоли, даёт полный доступ к ресурсам выбранных проектов. Скрипт ниже делает только GET, но храните секрет как боевой: в файле с правами 600 на одном сервере.
  2. Шаг 2. Установите CLI и проверьте ключ

    На сервере отчётов
    curl -fsSL https://h3llo.cloud/cli/install.sh | sh
    sudo apt install -y jq
    
    install -m 600 /dev/null ~/.h3-inventory.env
    cat > ~/.h3-inventory.env <<'EOF'
    export H3_KEY_ID="<ID ключа>"
    export H3_SECRET_KEY="<секретный ключ h3_...>"
    export H3_PROJECT_ID="<ID проекта>"
    EOF
    . ~/.h3-inventory.env && h3 vm list

    Проверка

    h3 vm list выводит таблицу машин проекта. В консоли у ключа inventory появилась строка «Использован …».

    Если не получилось

    • 401 — ключ выключен, истёк или перепутаны ID и секрет. 403 — проект не выбран в поле Проекты ключа.
    • Время сервера должно быть точным: подпись запроса живёт 5 минут (timedatectl → System clock synchronized: yes).
  3. Шаг 3. Напишите скрипт отчёта

    Каждая команда h3 … list -o json сохраняет ответ API как есть. Сводку собираем jq из машин и дисков; остальные файлы — снимок на дату, который удобно сравнивать diff с прошлым днём.

    /usr/local/bin/inventory-report.sh
    #!/usr/bin/env bash
    # Ежедневный снимок ресурсов проекта h3llo.cloud (только GET-запросы).
    set -euo pipefail
    . "$HOME/.h3-inventory.env"
    OUT="$HOME/inventory/$(date +%F)"
    mkdir -p "$OUT"
    
    h3 vm list            -o json > "$OUT/vms.json"
    h3 disk list          -o json > "$OUT/disks.json"
    h3 db list            -o json > "$OUT/databases.json"
    h3 network eip list   -o json > "$OUT/eips.json"
    h3 network vpc list   -o json > "$OUT/vpcs.json"
    h3 sg list            -o json > "$OUT/security-groups.json"
    h3 k8s list           -o json > "$OUT/k8s.json"
    h3 s3 bucket list     -o json > "$OUT/buckets.json"
    h3 dns zone list      -o json > "$OUT/dns-zones.json" || true   # если DNS в проекте не используется
    
    echo "== Машины"
    jq -r '.[] | [.name, .status, "\(.cpu) vCPU", .memory, (.endpoint // "-")] | @tsv' "$OUT/vms.json" | column -t
    echo "== Диски без машины"
    jq -r '.[] | select((.attached_to_vm_id // "") == "") | [.name, .size, .storage_class, .status] | @tsv' "$OUT/disks.json" | column -t
    echo "== Снимок: $OUT"
    Установка и первый запуск
    sudo nano /usr/local/bin/inventory-report.sh   # вставьте скрипт
    sudo chmod 755 /usr/local/bin/inventory-report.sh
    inventory-report.sh

    Проверка

    Скрипт печатает таблицу машин и список дисков без машины, а в ~/inventory/<дата>/ лежат JSON-файлы по каждому сервису.

    Если не получилось

    • Диск «без машины» — это часто забытый диск после удаления сервера. Он продолжает тарифицироваться, пока существует.
  4. Шаг 4. Найдите свободные адреса

    Свободный публичный IP оплачивается так же, как привязанный. Список адресов смотрите в таблице — колонки адреса, привязки и статуса покажут, какие ни к чему не подключены.

    На сервере отчётов
    . ~/.h3-inventory.env && h3 network eip list

    В консоли то же видно в разделе IP адреса проекта: свободный адрес можно удалить или привязать к ресурсу.

  5. Шаг 5. Поставьте отчёт в расписание

    На сервере отчётов
    ( crontab -l 2>/dev/null; echo '15 7 * * * /usr/local/bin/inventory-report.sh >> $HOME/inventory/report.log 2>&1' ) | crontab -
    # сравнение со вчерашним днём
    diff <(jq -S . ~/inventory/$(date -d yesterday +%F)/vms.json) <(jq -S . ~/inventory/$(date +%F)/vms.json)

    Проверка

    Утром в ~/inventory/report.log появляется свежая сводка, а diff показывает, какие машины появились или пропали за сутки.

Проверка результата

Сверьте сводку с консолью: число строк в «Машины» совпадает со списком Инстансы, а диски «без машины» в разделе Диски не подключены ни к одной машине.

Терминал
jq length ~/inventory/$(date +%F)/vms.json

Как удалить ресурсы

  1. Уберите задание из расписания: crontab -l | grep -v inventory-report | crontab -.
  2. API-ключи → inventory → меню «…» → Удалить → Подтвердить. Ключ перестаёт работать сразу.
  3. Удалите ~/.h3-inventory.env и, если не нужны, снимки ~/inventory/.

Типичные ошибки

Можно ли сделать ключ только на чтение?

Ключ из консоли даёт полный доступ к выбранным проектам. Ограничьте его проектами и сроком, используйте только в этом скрипте и не давайте его внешним системам с правом записи.

Нужен отчёт по нескольким проектам

Выберите их все в поле **Проекты** ключа и запускайте скрипт в цикле с `-p <ID проекта>` у каждой команды или с разными `H3_PROJECT_ID`.

Где расходы в рублях?

Отчёт показывает только ресурсы, без сумм. Разбивка расходов по ресурсам — в консоли, раздел биллинга; как считаются цены — в статье «Как считается стоимость облака».

Скрипт на Python вместо CLI

Подойдёт `h3sign.py` из документации docs.h3llo.cloud/api/auth: `python3 h3sign.py GET "https://api.h3llo.cloud/api/vms/v1?project_id=$H3_PROJECT_ID"` возвращает тот же JSON.

Связанные продукты и материалы

Попробовать в h3llo.cloud

Новым пользователям — 4 000 ₽ на 30 дней на любые сервисы: бонуса хватит, чтобы попробовать этот сценарий целиком. Бонус начисляется после подтверждения телефона и привязки карты.