HTTP API
Содержание раздела
Методы по управлению запросами и асинхронными операциями
| Запросы |
|---|
POST /api/v1/datamarts[/{datamart}]/query Выполняет запрос SQL+, указанный в теле сообщения |
POST /api/v1/datamarts[/{datamart}]/ddl Выполняет DDL-запрос, указанный в теле сообщения |
POST /api/v1/datamarts/{datamart}/entities/{entity}/upload Выполняет потоковую загрузку данных, указанных в теле сообщения |
| Асинхронные операции |
|---|
GET /api/v1/datamarts[/{datamart}]/query/{requestId} Возвращает подробную информацию по асинхронной операции |
GET /api/v1/datamarts[/{datamart}]/queries Возвращает краткую информацию по всем асинхронным операциям логической БД или окружения |
POST /api/v1/datamarts[/{datamart}]/query/{requestId} Удаляет информацию об асинхронной операции |
POST /api/v1/datamarts[/{datamart}]/queries Удаляет информацию обо всех асинхронных операциях логической БД или окружения |
Методы по управлению дельтами
| Дельта по номеру |
|---|
GET /api/v1/datamarts/{datamart}/deltas/{deltaNum} Возвращает информацию о дельте с номером {deltaNum} |
| Текущая/последняя дельта |
|---|
GET /api/v1/datamarts/{datamart}/deltas/current Возвращает информацию о текущей дельте по серверному времени |
GET /api/v1/datamarts/{datamart}/deltas/latest Возвращает информацию о последней закрытой и открытой дельтах |
GET /api/v1/datamarts/{datamart}/deltas/latest/hot Возвращает информацию об открытой дельте |
GET /api/v1/datamarts/{datamart}/deltas/latest/ok Возвращает информацию о последней закрытой дельте |
Методы по управлению схемой данных
| Все логические базы данных |
|---|
GET /api/v1/datamarts Возвращает список имен логических БД в текущем окружении |
| Логическая база данных |
|---|
GET /api/v1/datamarts/{datamart}/entities Возвращает список имен сущностей в логической БД {datamart} |
POST /api/v1/datamarts/{datamart}/sync Обновляет кэш по логической БД {datamart}, синхронизируя его с сервисной базой данных |
| Логическая сущность: таблица или представление |
|---|
GET /api/v1/datamarts/{datamart}/entities/{entity} Возвращает метаданные логической сущности {entity} |
GET /api/v1/datamarts/{datamart}/entities/{entity}/ddl Возвращает DDL-запрос на создание логической сущности {entity} в текущем состоянии |
Методы по управлению компонентами
GET /api/v1/versions Возвращает информацию о версиях программных компонентов: компонентов ноды Prostore и внешних компонентов |
Методы по управлению статистикой
| Получение статистики |
|---|
GET /api/v1/datamarts/{datamart}/entities/{entity}/statistics Возвращает статистику по сущности {entity} |
GET /api/v1/datamarts/{datamart}/statistics Возвращает статистику по всем сущностям логической БД {datamart} |
GET /api/v1/datamarts/all/statistics Возвращает статистику по всем сущностям всех логических БД текущего окружения |
| Обнуление статистики |
|---|
POST /api/v1/datamarts/{datamart}/entities/{entity}/statistics Обнуляет статистику по сущности {entity} |
POST /api/v1/datamarts/{datamart}/statistics Обнуляет статистику по всем сущностям логической БД {datamart} |
POST /api/v1/datamarts/all/statistics Обнуляет статистику по всем сущностям всех логических БД текущего окружения |
Методы по управлению спецификацией
GET /swagger-ui Возвращает HTML-страницу с OpenAPI-спецификацией в формате Swagger UI |
Методы по мониторингу состояния нод
GET /actuator/health/startup Возвращает информацию о состоянии ноды после запуска/перезапуска |
GET /actuator/health/liveness Возвращает информацию о доступности ноды |
GET /actuator/health/readiness Возвращает информацию о готовности ноды к обработке запросов |
GET /actuator/health Возвращает возвращает информацию об общем состоянии ноды |