7.3. REST API eCA-VA
Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA
Раздел: REST API eCA-VA.
Методы получения информации о сервисе безопасности (security-service)
Заголовок раздела «Методы получения информации о сервисе безопасности (security-service)»Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе безопасности |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | security-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/security-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/security-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/security-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/security-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/security-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса безопасности (security-service)
Заголовок раздела «Метод получения информации о состоянии сервиса безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса безопасности |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | security-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе безопасности (security-service)
Заголовок раздела «Метод получения информации о сервисе безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе безопасности |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | security-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса безопасности (security-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса безопасности (security-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса безопасности |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | security-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе журнала событий (logs-service)
Заголовок раздела «Методы получения информации о сервисе журнала событий (logs-service)»Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе журнала событий |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | logs-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/logs-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST - адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/logs-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST - адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/logs-service/actuator/health/{*path}`”,` | URL зарезервированного эндпоинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/logs-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST - адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/logs-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST - адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса журнала событий (logs-service)
Заголовок раздела «Метод получения информации о состоянии сервиса журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса журнала событий |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | logs-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе журнала событий (logs-service)
Заголовок раздела «Метод получения информации о сервисе журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе журнала событий |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | logs-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса журнала событий (logs-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса журнала событий (logs-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса журнала событий |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | logs-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Методы получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)»Метод получения эндпоинтов для запроса информации о сервисе интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе интеграции с центром сертификации (ca-adapter-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе интеграции с центром сертификации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | ca-adapter-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/ca-adapter-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/ca-adapter-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/ca-adapter-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/ca-adapter-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/ca-adapter-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения информации о состоянии сервиса интеграции с центром сертификации (ca-adapter-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса интеграции с центром сертификации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | ca-adapter-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе интеграции с центром сертификации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | ca-adapter-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса интеграции с центром сертификации (ca-adapter-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса интеграции с центром сертификации |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | ca-adapter-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе валидации (validation-authority-service)
Заголовок раздела «Методы получения информации о сервисе валидации (validation-authority-service)»Метод получения эндпоинтов для запроса информации о сервисе валидации (validation-authority-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе валидации (validation-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе валидации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | validation-authority-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/validation-authority-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/validation-authority-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/validation-authority-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/validation-authority-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/validation-authority-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса валидации (validation-authority-service)
Заголовок раздела «Метод получения информации о состоянии сервиса валидации (validation-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса валидации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | validation-authority-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе валидации (validation-authority-service)
Заголовок раздела «Метод получения информации о сервисе валидации (validation-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе валидации |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | validation-authority-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса валидации (validation-authority-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса валидации (validation-authority-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса валидации |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | validation-authority-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе настроек (settings-service)
Заголовок раздела «Методы получения информации о сервисе настроек (settings-service)»Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе настроек |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | settings-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/settings-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/settings-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/settings-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/settings-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/settings-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса настроек (settings-service)
Заголовок раздела «Метод получения информации о состоянии сервиса настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса настроек |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | settings-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения информации о сервисе настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе настроек |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | settings-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения информации о сервисе настроек (settings-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса настроек |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | settings-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе хранения данных (storage-service)
Заголовок раздела «Методы получения информации о сервисе хранения данных (storage-service)»Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе хранения данных |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | storage-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/storage-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/storage-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/storage-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/storage-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/storage-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса хранения данных (storage-service)
Заголовок раздела «Метод получения информации о состоянии сервиса хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса хранения данных |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | storage-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе хранения данных (storage-service)
Заголовок раздела «Метод получения информации о сервисе хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе хранения данных |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | storage-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса хранения данных (storage-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса хранения данных (storage-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса хранения данных |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | storage-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |
Методы получения информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Методы получения информации о сервисе внешних интеграций (external-integration-service)»Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение списка доступных эндпоинтов для запроса информации о сервисе внешних интеграций |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | external-integration-service/actuator |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| _links: | Ссылки на доступные эндпоинты сервиса |
| self: | Эндпоинты для получения информации о самом сервисе |
"href": "https://HOST/external-integration-service/actuator`”,` | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health: | Эндпоинты для получения информации о состоянии сервиса |
"href": "https://HOST/external-integration-service/actuator/health`”,` | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| health-path: | Зарезервированный эндпоинт под будущие реализации |
"href": "https://HOST/external-integration-service/actuator/health/{*path}`”,` | URL зарезервированного эндроинта под будущие реализации |
"templated": true | Флаг наличия переменной в URL |
| info: | Эндпоинты для получения информации о сервисе |
"href": "https://HOST/external-integration-service/actuator/info`”,` | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
| prometheus: | Эндпоинты для получения метрик в формате Prometheus |
"href": "https://HOST/external-integration-service/actuator/prometheus`”,` | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-VA |
"templated": false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о состоянии сервиса внешних интеграций |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | external-integration-service/actuator/health |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP — работает; - DOWN — не работает; - OUT_OF_SERVICE — выключен; - UNKNOWN — нет информации |
Метод получения информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения информации о сервисе внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение информации о сервисе внешних интеграций |
| Описание | Метод по умолчанию доступен неаутентифицированному пользователю. В конфигурационном файле имеется возможность отключения доступа неаутентифицированному пользователю. |
| URL | external-integration-service/actuator/info |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Ответ JSON в HTTP-body |
| application: | Информация о приложении |
name (string) | Название сервиса |
version (string) | Версия сервиса |
Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса внешних интеграций (external-integration-service)»| Параметр | Значение |
|---|---|
| Метод | GET – Получение Prometheus-метрик сервиса внешних интеграций |
| Описание | Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла:- если параметр имеет значение true, доступ к методу будет разрешен только аутентифицированным пользователям;- если параметр имеет значение false (по умолчанию), доступ к методу будет разрешен без аутентификации. |
| URL | external-integration-service/actuator/prometheus |
| Swagger | - |
| Query | - |
| Request | - |
| Response | Метод возвращает метрики сервиса в формате Prometheus (text/plain) |