Для AI-агентов: markdown этой страницы — /docs-content/infra/servers/disk-usage.md индекс документации — /llms.txt
Получить отчёт о диске галактики
GET /v1/infra/servers/:id/disk-usage
Возвращает сохранённый отчёт о диске галактики. Запрос не будит хост, не запускает замер и не удаляет данные.
Авторизация: API-ключ, для ключа приложения — сессия пользователя. Передайте идентификатор хоста галактики или приложения текущего ключа. Ключ хоста видит все живые приложения. Ключ приложения видит только приложения того же ключа, даже если остальные ключи принадлежат тому же человеку. Данные остальных приложений объединены в otherDataMb без имён и идентификаторов.
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
Параметрid (path) |
Типstring (UUID) | ОбязательныйДа | ОписаниеИдентификатор хоста галактики или приложения текущего ключа из списка серверов. Хост, на который ссылается приложение ключа, приходит там строкой с access.via: "galaxy-reference" |
Примеры
curl — личный ключ
curl 'https://vibecode.bitrix24.tech/v1/infra/servers/3f7a91c4-6e0b-42d8-8b55-19ad7c204e6f/disk-usage' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth-приложение
curl 'https://vibecode.bitrix24.tech/v1/infra/servers/3f7a91c4-6e0b-42d8-8b55-19ad7c204e6f/disk-usage' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/infra/servers/3f7a91c4-6e0b-42d8-8b55-19ad7c204e6f/disk-usage', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/infra/servers/3f7a91c4-6e0b-42d8-8b55-19ad7c204e6f/disk-usage', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
Поля ответа
Все размеры указаны в мебибайтах. Неизвестный размер — null, а не ноль.
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типobject | null | ОписаниеСохранённый отчёт. null для обычного сервера или если успешного снимка ещё нет |
Полеdata.measuredAt |
Типstring (ISO 8601) | ОписаниеВремя выбранного снимка. Он может быть старше последней попытки замера |
Полеdata.outcome |
Типstring | Описаниеcomplete или partial: удалось ли выполнить выбранный замер полностью |
Полеdata.notMeasured |
Типarray of strings | ОписаниеРазделы, которые не удалось измерить в выбранном снимке, например images |
Полеdata.disk |
Типobject | ОписаниеОбщие показатели корневой файловой системы |
Полеdata.disk.totalMb |
Типnumber | null | ОписаниеПолный объём диска |
Полеdata.disk.usedMb |
Типnumber | null | ОписаниеЗанятое место |
Полеdata.disk.freeMb |
Типnumber | null | ОписаниеСвободное место |
Полеdata.apps |
Типarray | ОписаниеВидимые живые приложения по убыванию известного размера данных. Неизвестные размеры идут последними |
Полеdata.apps[].id |
Типstring (UUID) | ОписаниеИдентификатор приложения |
Полеdata.apps[].name |
Типstring | ОписаниеОтображаемое имя или системное имя, если отображаемое не задано |
Полеdata.apps[].dataMb |
Типnumber | null | ОписаниеРазмер тома приложения. null, если в снимке не найден соответствующий том |
Полеdata.otherDataMb |
Типnumber | null | ОписаниеДанные томов вне видимых приложений, включая удалённые и несопоставленные тома. Порядок расчёта описан ниже |
Полеdata.imagesMb |
Типnumber | null | ОписаниеМесто, занятое образами контейнеров |
Полеdata.imagesReclaimableMb |
Типnumber | null | ОписаниеМесто образов, которое потенциально можно освободить отдельной очисткой |
Полеdata.buildCacheMb |
Типnumber | null | ОписаниеРазмер кеша сборки |
Полеdata.buildCacheReclaimableMb |
Типnumber | null | ОписаниеМесто кеша сборки, которое потенциально можно освободить отдельной очисткой |
Полеdata.containersWritableMb |
Типnumber | null | ОписаниеИзменяемые слои контейнеров |
Полеdata.containerLogsMb |
Типnumber | null | ОписаниеФайлы журналов контейнеров |
Пример ответа
Ключ хоста:
{
"success": true,
"data": {
"measuredAt": "2026-11-16T09:00:00.000Z",
"outcome": "complete",
"notMeasured": [],
"disk": {
"totalMb": 1000,
"usedMb": 700,
"freeMb": 300
},
"apps": [
{
"id": "5c2d33e4-9f15-4347-a023-a2e3080c1073",
"name": "Foreign app",
"dataMb": 300
},
{
"id": "4b1c22d3-8e04-4236-9912-91d2f7fb0962",
"name": "My app",
"dataMb": 100
}
],
"otherDataMb": 200,
"imagesMb": 50,
"imagesReclaimableMb": 10,
"buildCacheMb": 20,
"buildCacheReclaimableMb": 15,
"containersWritableMb": 5,
"containerLogsMb": 25
}
}
Ключ приложения, по идентификатору своего приложения или хоста:
{
"success": true,
"data": {
"measuredAt": "2026-11-16T09:00:00.000Z",
"outcome": "complete",
"notMeasured": [],
"disk": {
"totalMb": 1000,
"usedMb": 700,
"freeMb": 300
},
"apps": [
{
"id": "4b1c22d3-8e04-4236-9912-91d2f7fb0962",
"name": "My app",
"dataMb": 100
}
],
"otherDataMb": 500,
"imagesMb": 50,
"imagesReclaimableMb": 10,
"buildCacheMb": 20,
"buildCacheReclaimableMb": 15,
"containersWritableMb": 5,
"containerLogsMb": 25
}
}
Успешного снимка нет или указан обычный сервер:
{
"success": true,
"data": null
}
Пример ответа при ошибке
404 — посторонний ключ получает тот же отказ, что и при чтении карточки сервера:
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Server not found"
}
}
Ошибки
| HTTP | Код | Условие |
|---|---|---|
| HTTP401 | КодMISSING_API_KEY |
УсловиеВ запросе нет API-ключа |
| HTTP401 | КодINVALID_API_KEY |
УсловиеAPI-ключ недействителен |
| HTTP404 | КодNOT_FOUND |
УсловиеСервер отсутствует, удалён или недоступен текущему ключу, в том числе при удалённом портале Битрикс24 |
| HTTP429 | КодCALLER_RATE_LIMITED |
УсловиеПревышен предел запросов к API для вызывающего клиента |
Остальные ограничения авторизации и портала описаны в разделе Ошибки.
Известные особенности
- Отчёт берётся из сохранённого снимка. Для спящего хоста остаются последние известные значения. Перед действиями проверяйте
measuredAt. - Из двух последних успешных снимков выбирается самый новый с непустым списком томов. Если такого нет, используется последний успешный снимок, даже если он
partial. ПолеnotMeasuredотносится именно к выбранному снимку. - В снимке сохраняется не более 30 самых крупных томов. У приложения вне этого списка или с несопоставленным именем тома будет
dataMb: null. При известной сумме томов его данные остаются вotherDataMb. - При известной сумме томов
otherDataMbравен этой сумме за вычетом известных размеров видимых приложений, но не меньше нуля. Если сумма неизвестна, складываются остальные перечисленные тома. Если общий объём томов не измерен и список томов отсутствует или пуст,otherDataMbравенnull. - Размеры образов и кеша сборки, доступные для освобождения, — оценки, а не свободное место. Запрос ничего не очищает. Занятое место может включать данные вне перечисленных категорий, поэтому их сумма не обязана совпадать с
disk.usedMb. - Доступ к хосту через приложение разрешает только чтение. Он не открывает команды, загрузку файлов или управление состоянием хоста. Операции приложения по-прежнему вызываются по идентификатору приложения.