KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
GET Статус хранилища
База данных
GET Информация о БД
GET Ресурсы
GET Распределение по модулям
Объектное хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
Склад (WM)
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

База данных

Методы для контроля хранилища данных организации.

# Получение информации

GET
/companies/{id}/storage/db

Возвращает основную информацию о базе данных организации: размер, количество таблиц, строк и подключений.

Структура ответа

RESPONSE_DATA:
application/json
schema_namerequired
string
Схема
Имя схемы PostgreSQL
total_size_mbrequired
int
Общий размер (МБ)
Общий объём данных в мегабайтах
total_size_prettyrequired
string
Размер
Человекочитаемый формат размера
table_size_mbrequired
int
Таблицы (МБ)
Объём таблиц
index_size_mbrequired
int
Индексы (МБ)
Объём индексов
table_countrequired
int
Таблиц
Количество таблиц
total_rowsrequired
int
Строк
Общее количество строк
active_connectionsrequired
int
Подключений
Количество активных подключений
schema_existsrequired
boolean
Существует
Существует ли схема

Примеры ответов

200
403
{
    "status": true,
    "message": "Database storage retrieved successfully",
    "data": {
        "schema_name": "company_660e8400",
        "total_size_mb": 42,
        "total_size_pretty": "42 MB",
        "table_size_mb": 30,
        "index_size_mb": 12,
        "table_count": 24,
        "total_rows": 15000,
        "active_connections": 3,
        "schema_exists": true
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../storage/db",
        "method": "GET"
    }
}

# Ресурсы

GET
/companies/{id}/storage/db/sources

Возвращает детальную информацию о ресурсах базы данных: таблицы, индексы, vacuum, строки.

Структура ответа

RESPONSE_DATA:
application/json
schema_namerequired
string
Схема
Имя схемы PostgreSQL
total_size_mbrequired
int
Общий размер (МБ)
Общий объём данных
total_size_prettyrequired
string
Размер
Человекочитаемый формат размера
table_size_mbrequired
int
Таблицы (МБ)
Объём таблиц
index_size_mbrequired
int
Индексы (МБ)
Объём индексов
toast_size_mbrequired
int
TOAST (МБ)
Объём TOAST-данных
table_countrequired
int
Таблиц
Количество таблиц
index_countrequired
int
Индексов
Количество индексов
sequence_countrequired
int
Последовательностей
Количество sequences
view_countrequired
int
Представлений
Количество views
materialized_view_countrequired
int
Материализованных
Количество materialized views
total_rowsrequired
int
Строк
Общее количество строк
dead_rowsrequired
int
Мёртвых строк
Количество dead rows
active_connectionsrequired
int
Подключений
Количество активных подключений
last_vacuumoptional
string
Последний vacuum
Дата последнего vacuum (RFC 3339)
last_autovacuumoptional
string
Последний autovacuum
Дата последнего autovacuum (RFC 3339)
last_analyzeoptional
string
Последний analyze
Дата последнего analyze (RFC 3339)
schema_existsrequired
boolean
Существует
Существует ли схема
created_atoptional
string
Создана
Дата создания (RFC 3339)
updated_atoptional
string
Обновлена
Дата обновления (RFC 3339)

Примеры ответов

200
403
{
    "status": true,
    "message": "Database sources retrieved successfully",
    "data": {
        "schema_name": "company_660e8400",
        "total_size_mb": 42,
        "total_size_pretty": "42 MB",
        "table_size_mb": 30,
        "index_size_mb": 10,
        "toast_size_mb": 2,
        "table_count": 24,
        "index_count": 48,
        "sequence_count": 12,
        "view_count": 4,
        "materialized_view_count": 2,
        "total_rows": 15000,
        "dead_rows": 200,
        "active_connections": 3,
        "last_vacuum": "2026-06-13T00:00:00Z",
        "last_autovacuum": "2026-06-14T00:00:00Z",
        "last_analyze": "2026-06-14T06:00:00Z",
        "schema_exists": true,
        "created_at": "2026-04-24T00:20:54Z",
        "updated_at": "2026-06-14T00:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../storage/db/sources",
        "method": "GET"
    }
}

# Распределение по модулям

GET
/companies/{id}/storage/db/sources/modules

Возвращает распределение ресурсов базы данных по модулям платформы.

Структура ответа

RESPONSE_DATA:
application/json
modulesrequired
array
Модули
Статистика по модулям (ModuleStats[])
totalrequired
array
Итого
Суммарная статистика по всем модулям (TotalStats)

Модуль

MODULE_STATS:
application/json
modulerequired
string
Модуль
Название модуля (fm, crm, hrm, wm, dm)
row_countrequired
int
Строк
Количество строк в таблицах модуля
table_countrequired
int
Таблиц
Количество таблиц модуля
total_size_mbrequired
int
Размер (МБ)
Общий объём данных модуля

Итого

TOTAL_STATS:
application/json
modulerequired
enum
total
Модуль
Всегда "total"
row_countrequired
int
Строк
Общее количество строк
table_countrequired
int
Таблиц
Общее количество таблиц
total_bytesrequired
int
Байт
Общий объём в байтах
total_size_mbrequired
int
Размер (МБ)
Общий объём в мегабайтах

Примеры ответов

200
{
    "status": true,
    "message": "Modules data retrieved successfully",
    "data": {
        "modules": {
            "fm": {
                "module": "fm",
                "row_count": 5000,
                "table_count": 6,
                "total_size_mb": 15
            },
            "crm": {
                "module": "crm",
                "row_count": 3000,
                "table_count": 4,
                "total_size_mb": 10
            }
        },
        "total": {
            "module": "total",
            "row_count": 15000,
            "table_count": 24,
            "total_bytes": 44040192,
            "total_size_mb": 42
        }
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../storage/db/sources/modules",
        "method": "GET"
    }
}