7.2.1. REST API eCA-RA (версия 2)
Aladdin Enterprise CAAPI и SDKAladdin Enterprise CA
Методы аутентификации
Заголовок раздела «Методы аутентификации»Метод аутентификации по сертификату (устаревший)
Заголовок раздела «Метод аутентификации по сертификату (устаревший)»| POST API – Аутентификация с помощью сертификата | |
|---|---|
| Данный метод позволяет выполнять аутентификацию в eCA-RA по сертификату доступа администратора или оператора подключенного eCA-CA. | |
| URL – /x509-provider-service/api/v2/public/auth/sign-in/x509 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
Метод аутентификации по Kerberos-ticket (устаревший)
Заголовок раздела «Метод аутентификации по Kerberos-ticket (устаревший)»| POST API – Аутентификация по Kerberos-ticket | |
|---|---|
| В случае аутентификации по реквизитам субъекта домена, к которому подключен eCA-RA, для которого существует связанная незаблокированная учетная запись в eCA-CA, вход в eCА-RA осуществляется под именем данной УЗ с соответствующими пользователю правами. | |
| URL – /kerberos-provider-service/api/v2/public/auth/sign-in/kerberos | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
В результате авторизации сервер возвращает cookies-файл с маркером доступа и токеном обновления. Для дальнейшей аутентификации используется данный маркер доступа.
Маркер доступа необходимо передать в http-header “token”, либо приложить к запросу полученный cookies-файл с маркером доступа (http-header “cookie”).
Метод аутентификации по логину и паролю (устаревший)
Заголовок раздела «Метод аутентификации по логину и паролю (устаревший)»| POST API – Аутентификация по логину и паролю | |
|---|---|
| В случае аутентификации по реквизитам субъекта домена, к которому подключен eCA-RA, для которого существует связанная незаблокированная учетная запись в eCA-CA, вход в eCА-RA осуществляется под именем данной УЗ с соответствующими пользователю правами. | |
| URL – /kerberos-provider-service/api/v2/public/auth/sign-in/ldap | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| Query - | |
| Request | |
| > username (string), | Имя пользователя |
| > password (string) | Пароль пользователя |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
В результате авторизации сервер возвращает cookies-файл с маркером доступа и токеном обновления. Для дальнейшей аутентификации используется данный маркер доступа.
Маркер доступа необходимо передать в http-header “token”, либо приложить к запросу полученный cookies-файл с маркером доступа (http-header “cookie”).
Метод аутентификации по сертификату
Заголовок раздела «Метод аутентификации по сертификату»| POST API – Аутентификация с помощью сертификата | |
|---|---|
| Данный метод позволяет выполнять аутентификацию в eCA-RA по сертификату доступа администратора или оператора подключенного eCA-CA. | |
| URL – /security-service/api/v2/public/auth/sign-in/x509 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Авторизации/signInByX509_1 | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
В результате успешной аутентификации сервер возвращает cookies-файл с маркером доступа и токеном обновления. Для дальнейшей аутентификации используется данный маркер доступа (см. примеры использования методов далее).
Маркер доступа необходимо передать в http-header “token”, либо приложить к запросу полученный cookies-файл с маркером доступа (http-header “cookie”).
Метод аутентификации по Kerberos-ticket
Заголовок раздела «Метод аутентификации по Kerberos-ticket»| POST API – Аутентификация по Kerberos-ticket | |
|---|---|
| В случае аутентификации по реквизитам субъекта домена, к которому подключен eCA-RA, для которого существует связанная незаблокированная учетная запись в eCA-CA, вход в eCА-RA осуществляется под именем данной УЗ с соответствующими пользователю правами. | |
| URL – /security-service/api/v2/public/auth/sign-in/kerberos | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Авторизации/kerberosSignIn | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
В результате авторизации сервер возвращает cookies-файл с маркером доступа и токеном обновления. Для дальнейшей аутентификации используется данный маркер доступа.
Маркер доступа необходимо передать в http-header “token”, либо приложить к запросу полученный cookies-файл с маркером доступа (http-header “cookie”).
Метод аутентификации по логину и паролю
Заголовок раздела «Метод аутентификации по логину и паролю»| POST API – Аутентификация по логину и паролю | |
|---|---|
| В случае аутентификации по реквизитам субъекта домена, к которому подключен eCA-RA, для которого существует связанная незаблокированная учетная запись в eCA-CA, вход в eCА-RA осуществляется под именем данной УЗ с соответствующими пользователю правами. | |
| URL – /security-service/api/v2/public/auth/sign-in/ldap | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Авторизации/ldapSignIn | |
| Query - | |
| Request | |
| > username (string), | Имя пользователя |
| > password (string) | Пароль пользователя |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
В результате авторизации сервер возвращает cookies-файл с маркером доступа и токеном обновления. Для дальнейшей аутентификации используется данный маркер доступа.
Маркер доступа необходимо передать в http-header “token”, либо приложить к запросу полученный cookies-файл с маркером доступа (http-header “cookie”).
Метод обновления маркера доступа
Заголовок раздела «Метод обновления маркера доступа»| PUT API – Обновления токена доступа | |
|---|---|
| Метод доступен администратору и оператору | |
| URL – /security-service/api/v2/public/auth/refresh-token | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Авторизации/refreshToken | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| token (string), | Маркер доступа |
| refresh (string) | Токен обновления |
Методы работы с заявками
Заголовок раздела «Методы работы с заявками»Метод создания новой заявки на выпуск сертификата с закрытым ключом (PKCS#12)
Заголовок раздела «Метод создания новой заявки на выпуск сертификата с закрытым ключом (PKCS#12)»| POST API – Создание новой заявки на выпуск сертификата в контейнере PKCS#12 | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем из eCA-СA, к которому подключен eCA-RA. Если в рамках создания заявки осуществляется вызов метода создания субъекта[1] публичного API eCA-CA, в заголовке “X-User-Context” будет передан идентификатор УЗ оператора, от имени которого осуществляется попытка создания заявки. В случае, если у оператора нет полномочий на создание нового локального субъекта, в ответе метода создания заявки будет возвращаться ошибка с кодом 403 и текстом “Создание заявки недоступно. Отсутствуют полномочия на создание новых субъектов”. | |
| URL – /tasks-service/api/v2/public/tasks/pkcs12 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/registerPkcs12 | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[2]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. |
| templateId (uuid), [обязательно | ID шаблона сертификата[3]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным.[4] |
| Request | |
| subjectDN: { > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, | Поля разделенного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectAltName: { > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] }, | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| keyBits (integer), | Длина ключа |
| keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), | Алгоритм ключевой пары сертификата |
| password (string) | Пароль контейнера |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[5] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[6] |
| certificateId(uuid), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки. |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| > created (instant), | Время создания заявки (ISO 8601) |
| > foreignKey (string) | Внешний ключ заявки |
Метод создания новой заявки на основании запроса PKCS#10
Заголовок раздела «Метод создания новой заявки на основании запроса PKCS#10»Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)
Заголовок раздела «Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – multipart/form-data)»| POST API – Создание новой заявки на основании запроса PKCS#10 | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем из eCA-СA, к которому подключен eCA-RA. Если в рамках создания заявки осуществляется вызов метода создания субъекта[7] публичного API eCA-CA, в заголовке “X-User-Context” будет передан идентификатор УЗ оператора, от имени которого осуществляется попытка создания заявки. В случае, если у оператора нет полномочий на создание нового локального субъекта, в ответе метода создания заявки будет возвращаться ошибка с кодом 403 и текстом “Создание заявки недоступно. Отсутствуют полномочия на создание новых субъектов”. | |
| URL – /tasks-service/api/v2/public/tasks/pkcs10 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/registerPkcs10AsFileDescription | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[8]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. Может быть указан при использовании метода учетной записью с ролью “Администратор”.[9] |
| templateId (uuid), [обязательно | ID шаблона сертификата[10]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным.[11] |
| Request | |
| request (MultipartFile), | PKCS#10 файл запроса на сертификат |
| subjectName: { > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, [опционально | Поля отличительного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| subjectAltName: { > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Необязательный параметр, задается в случае невозможности поместить данные в PKCS10. Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[12] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[13] |
| certificateId (string), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| > created (instant), | Время создания заявки (ISO 8601) |
| > foreignKey (string) | Внешний ключ заявки |
Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)
Заголовок раздела «Метод создания новой заявки на основании запроса PKCS#10 (формат запроса на сертификат из входных параметров – application/json)»| POST API – Создание новой заявки на основании запроса PKCS#10 | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно только создание заявок, получателем сертификата по которым является субъект, связанный с данной учетной записью. Для УЗ с ролью “Администратор” или “Оператор” с использованием данного метода доступно создание заявок для субъектов ресурсных систем из eCA-СA, к которому подключен eCA-RA. Если в рамках создания заявки осуществляется вызов метода создания субъекта[14] публичного API eCA-CA, в заголовке “X-User-Context” будет передан идентификатор УЗ оператора, от имени которого осуществляется попытка создания заявки. В случае, если у оператора нет полномочий на создание нового локального субъекта, в ответе метода создания заявки будет возвращаться ошибка с кодом 403 и текстом “Создание заявки недоступно. Отсутствуют полномочия на создание новых субъектов”. | |
| URL – /tasks-service/api/v2/public/tasks/pkcs10 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/registerPkcs10AsFileDescription | |
| Query | |
| certificateAuthorityId (uuid), [опционально | ID Центра сертификации, на котором должен быть выпущен сертификат по заявке. Если для данного параметра не указано значение, выпуск будет осуществляться на Центре сертификации подключенного eCA-CA, который определен в используемом шаблоне (поле “templateId”). Если в используемом шаблоне не определен конкретный центр сертификации (указано значение “Любой”), выпуск будет осуществляться на активном на момент создания заявки Центре сертификации подключенного eCA-CA. |
| subjectId (uuid), [опционально | ID субъекта[15]. Должен отсутствовать при использовании метода учетной записью с ролью “Пользователь”. Может быть указан при использовании метода учетной записью с ролью “Администратор”.[16] |
| templateId (uuid), [обязательно | ID шаблона сертификата[17]. |
| foreignKey (string) [опционально | Внешний ключ заявки. Внешний ключ должен быть уникальным.[18] |
| Request | |
| request: | Запрос на сертификат |
| contentType (string) [опционально], | Тип загружаемого файла (HTTP MediaType) - application/octet-stream) |
| fileName (string) [опционально], | Имя загружаемого файла |
| data (string:binary) | Содержимое PEM файла запроса на сертификат (массив байт в Base64) |
| subjectName: { > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string[] }, [опционально | Поля отличительного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Значения полей, указанные в subjectName, переопределяют значения соответствующих полей SDN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| subjectAltName: { > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string[] | Поля альтернативного имени субъекта, которое должно попасть в сертификат. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра. Необязательный параметр, задается в случае невозможности поместить данные в PKCS10. Значения полей, указанные в subjectAltName, переопределяют значения соответствующих полей SAN запроса на сертификат, при условии, что они соответствуют значениям атрибутов субъекта. |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[19] |
| type (enum: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (enum: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[20] |
| certificateId (string), | Идентификатор сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| > created (instant), | Время создания заявки (ISO 8601) |
| > foreignKey (string) | Внешний ключ заявки |
Метод получения заявки по идентификатору
Заголовок раздела «Метод получения заявки по идентификатору»| GET API – Получение заявки по идентификатору | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение только тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение заявок, созданных данной УЗ, а также заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение любых заявок. | |
| URL – /tasks-service/api/v2/public/tasks/{id | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/findById | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[21] |
| certificateAuthorityId (uuid), | Идентификатор сертификата издателя |
| type (string: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (string: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[22] |
| certificateId (uuid), | ID сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string), | Внешний ключ заявки |
| templateName (string), | Имя шаблона сертификата |
| msUpn (string) | UPN субъекта |
Метод получения заявки по внешнему ключу
Заголовок раздела «Метод получения заявки по внешнему ключу»| GET API – Получение заявки по внешнему ключу | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение только тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение заявок, созданных данной УЗ, а также заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение любых заявок. | |
| URL – /tasks-service/api/v2/public/tasks/foreign-key/{foreignKey | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/findByForeignKey | |
| Query | |
| > foreignKey (string) | Внешний ключ заявки |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[23] |
| certificateAuthorityId (uuid), | Идентификатор сертификата издателя |
| type (string: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (string: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[24] |
| certificateId (uuid), | ID сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string), | Внешний ключ заявки |
| templateName (string), | Имя шаблона сертификата |
| msUpn (string) | UPN субъекта |
Метод поиска заявок
Заголовок раздела «Метод поиска заявок»| GET API – Поиск заявок | |
|---|---|
| Для УЗ с ролью “Пользователь” в ответе данного метода возвращаются только те заявки, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” в ответе данного метода возвращаются заявки, созданные данной УЗ, а также заявки для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” в ответе данного метода возвращаются все существующие заявки. | |
| URL – /tasks-service/api/v2/public/tasks | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/findA | l |
| Query | |
| sortDirection (string), | Направления сортировки (ASC;DESC) |
| sortBy (string[]), | Список полей, к которым применяется сортировка |
| pageOffset (integer), | Смещение от начала списка (пагинация) |
| pageLimit (integer), | Ограничение на размер выборки (пагинация) |
| search (string), | Полнотекстовый поиск |
| foreignKeys (string[]), | Фильтр: список внешних ключей |
| tempalteIds (uuid[]), | Фильтр: список ID шаблонов |
| creatorIds (uuid[]), | Фильтр: список ID УЗ для фильтрации |
| types (enum[]: PKCS10, PKCS12, SCEP, WSTEP, ON_TOKEN, UNKNOWN), | Фильтр: список типов заявки |
| statuses (enum[]: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Фильтр: список статусов заявки |
| certificateAuthorityId (string[]), | Фильтр: список ID Центров сертификации |
| serialnumber (string), | Поиск заявки по серийному номеру сертификата |
| fingerprint (string[]), | Фильтр: список отпечатков сертификатов |
| subjectKeyIdentifier (string[]) | Фильтр: Идентификатор ключа субъекта |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | ID заявки |
| templateId (uuid), | ID шаблона сертификата[25] |
| certificateAuthorityId (uuid), | Идентификатор сертификата издателя |
| type (string: PKCS10, PKCS12, ON_TOKEN, SCEP, WSTEP, UNKNOWN), | Тип заявки |
| status (string: NEW, FOR_APPROVE, ISSUE_ERROR, REJECTED, AWAITING_IMPORT, COMPLETED, CANCELLED, UNKNOWN), | Статус заявки |
| creatorId (uuid), | ID учетной записи автора заявки |
| subjectId (uuid), | ID субъекта[26] |
| certificateId (uuid), | ID сертификата. Заполняется по итогам успешной отработки заявки |
| name (string), | Common Name сертификата |
| updated (instant), | Время обновления заявки (ISO 8601) |
| created (instant), | Время создания заявки (ISO 8601) |
| foreignKey (string), | Внешний ключ заявки |
| templateName (string), | Имя шаблона сертификата |
| msUpn (string) | UPN субъекта |
Метод получения данных о выпущенном сертификате заявки по ее идентификатору
Заголовок раздела «Метод получения данных о выпущенном сертификате заявки по ее идентификатору»| GET API – Получение данных о выпущенном сертификате заявки по ее идентификатору | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение данных о выпущенных сертификатах только по тем заявкам, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение данных о выпущенных сертификатах только по созданным данным оператором заявкам, а также по заявкам для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение данных о выпущенных сертификатах по любым заявкам. В ответе данного метода в полях “subjectDN” и “issuerDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в сертификате будут указаны как “UNKNOWN”. Данные компоненты поддерживаются в публичном API начиная с версии v3. | |
| URL – /middleware-service/api/v2/public/tasks/{id}/certificate | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20Задачи/findCertificateByTaskId | |
| Query | |
| id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (uuid), | Идентификатор сертификата |
| chain: | Цепочка сертификатов (рекурсивный объект) |
| id (uuid), | Идентификатор сертификата |
| name (string), | Имя сертификата (на основе CN) |
| subjectDN: | Имя субъекта сертификата |
| (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string | Поля разделенного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| issuer: {… | Издатель сертификата (вложенный объект) |
| serialnumber (string), | Серийный номер сертификата |
| fingerprint (string), | Фингерпринт сертификата |
| name (string), | Имя сертификата (на основе CN) |
| issuerId (uuid), | Идентификатор издателя сертификата |
| issuerDN: | Имя субъекта издателя сертификата |
| > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string | Поля разделенного имени субъекта издателя из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectDN: | Имя субъекта сертификата |
| > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): string | Поля разделенного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| subjectAltName: | Альтернативное имя субъекта сертификата |
| > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): string | Поля альтернативного имени субъекта из сертификата. В формате key-value. Где key – один из перечисленных в enum параметров, а value – значение параметра |
| keyAlgorithm (enum: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN), | Алгоритм ключа сертификата ЦС |
| hashAlgorithm (enum: SHA1, SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512, RSASSA_PSS, MD5, GOST_R_34_11_2012, UNKNOWN), | Алгоритм подписи сертификата ЦС |
| keyBits (int32), | Длина ключа сертификата ЦС |
| templateId (uuid), | Идентификатор шаблона[27] |
| templateName (string), | Имя шаблона |
| type (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип сертификата |
| validFrom (instant), | Дата начала действия сертификата (ISO 8601) |
| validTo (instant), | Дата окончания действия сертификата (ISO 8601) |
| status (enum: ACTIVE, HOLD, REVOKE, REQUEST, UNKNOWN), | Статус сертификата |
| actions: | Доступные действия по выгрузке |
| p12 (boolean), | Флаг: выгрузка pkcs12 |
| csr (boolean), | Флаг: выгрузка pkcs10 |
| pem (boolean) | Флаг: выгрузка сертификата |
| > }, | |
| > publicKey (string), | Открытый ключ |
| > certificateType (string), | Тип сертификата (X.509) |
| > version (int32), | Версия сертификата |
| > subjectKeyIdentifier (string), | Идентификатор ключа сертификата |
| > authorityKeyIdentifier (string) | Идентификатор ключа издателя сертификата |
| > keyUsages: | Назначение ключа сертификата |
| > id (enum: DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN), | Перечисление использования ключа |
| > value (string), | Наименование элемента |
| > description (string) | Описание использования ключа |
| > }, | |
| > extendedKeyUsages: | Расширенное назначение ключа сертификата |
| > id (enum: EKU_PKIX_ANY_EXTENDED_KEY_USAGE, CSN_369791_TLS_CLIENT, CSN_369791_TLS_SERVER, CLIENT_AUTHENTICATION, CODE_SIGNING, EAP_OVER_LAN, EAP_OVER_PPP, ETSI_TSL_SIGNING, EMAIL_PROTECTION, ICAO_DEVIATION_LIST_SIGNING, EKU_INTEL_AMT, INTERNET_KEY_EXCHANGE_FOR_IPSEC, KERBEROS_CLIENT_AUTHENTICATION, EKU_KRB_PKINIT_KDC, MS_COMMERCIAL_CODE_SIGNING, MS_DOCUMENT_SIGNING, MS_EFS_RECOVERY, MS_ENCRYPTED_FILE_SYSTEM, MS_INDIVIDUAL_CODE_SIGNING, MS_SMART_CARD_LOGON, OCSP_SIGNER, EKU_ADOBE_PDF_SIGNING, PIV_CARD_AUTHENTICATION, SCVP_CLIENT, SCVP_SERVER, SIP_DOMAIN, EKU_PKIX_SSH_CLIENT, SSH_SERVER, SERVER_AUTHENTICATION, TIME_STAMPING, ICAO_MASTER_LIST_SIGNING, UNKNOWN), | Перечисление расширенного использования ключа |
| > value (string), | Наименование элемента |
| > oid (string), | OID назначения |
| > description (string) | Описание использования ключа |
| > }, | Описание OID |
| > ca (boolean), | Флаг: сертификат ЦС |
| aiaUrls (string[]), | URL AIA |
| ocspUrls (string[]), | URL OCSP |
| crlUrls (string[]), | URL CRL |
| deltaCrlUrls (string[]), | URL Delta CRL |
Методы экспорта файлов
Заголовок раздела «Методы экспорта файлов»Метод получения запроса на сертификат по идентификатору заявки
Заголовок раздела «Метод получения запроса на сертификат по идентификатору заявки»| GET API – Получение запроса на сертификат по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение запроса на сертификат только из тех заявок на сертификат на основании запроса, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение запроса на сертификат только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение запроса на сертификат из любых заявок на сертификат на основании запроса. Для успешного получения запроса на сертификат из заявки она должна иметь тип “PKCS10”. | |
| URL – /export-service/api/v2/public/export/task/{id}/request | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findRequestByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения сертификата по идентификатору заявки
Заголовок раздела «Метод получения сертификата по идентификатору заявки»| GET API – Получение сертификата по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение сертификатов только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение сертификата только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение сертификатов из любых заявок. Для успешного получения сертификата из заявки она должна иметь статус “COMPLETED”. | |
| URL – /export-service/api/v2/public/export/task/{id}/certificate | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findCertificateByTaskId_1 | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения цепочки сертификатов по идентификатору заявки
Заголовок раздела «Метод получения цепочки сертификатов по идентификатору заявки»| GET API – Получение цепочки сертификатов по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение цепочки сертификатов только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение цепочки сертификатов только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение цепочки сертификатов из любых заявок. Для успешного получения цепочки сертификатов из заявки она должна иметь статус “COMPLETED”. | |
| URL – /export-service/api/v2/public/export/task/{id}/chain | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findChainByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения контейнера pkcs12 по идентификатору заявки
Заголовок раздела «Метод получения контейнера pkcs12 по идентификатору заявки»| GET API – Получение контейнера pkcs12 по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение контейнера pkcs12 только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение контейнера pkcs12 только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение контейнера pkcs12 из любых заявок. Для успешного получения контейнера pkcs12 из заявки она должна иметь статус “COMPLETED” и тип “PKCS12”. | |
| URL – /export-service/api/v2/public/export/task/{id}/pkcs12 | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findP12ByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения сертификата издателя сертификата по заявке
Заголовок раздела «Метод получения сертификата издателя сертификата по заявке»| GET API – Получение сертификата издателя сертификата по заявке | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение сертификата издателя только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение сертификата издателя только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение сертификата издателя из любых заявок. Для успешного получения сертификата издателя из заявки она должна иметь статус “COMPLETED”. | |
| URL – /export-service/api/v2/public/export/task/{id}/issuer/certificate | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findIssuerCertificateByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения цепочки сертификатов издателя сертификата по заявке
Заголовок раздела «Метод получения цепочки сертификатов издателя сертификата по заявке»| GET API – Получение цепочки сертификатов издателя сертификата по заявке | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение цепочки сертификатов издателя только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение цепочки сертификатов издателя только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение цепочки сертификатов издателя из любых заявок. Для успешного получения цепочки сертификатов издателя из заявки она должна иметь статус “COMPLETED”. | |
| URL – /export-service/api/v2/public/export/task/{id}/issuer/chain | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findIssuerChainByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Метод получения CRL издателя сертификата по заявке
Заголовок раздела «Метод получения CRL издателя сертификата по заявке»| GET API – Получение CRL издателя сертификата по заявке | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение CRL издателя только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступно CRL издателя только из созданных данным оператором заявок, а также из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение CRL издателя из любых заявок. Для успешного получения CRL издателя из заявки она должна иметь статус “COMPLETED”. | |
| URL – /export-service/api/v2/public/export/task/{id}/issuer/crl | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%20экспорта/findIssuerCrlByTaskId | |
| Query | |
| > id (uuid) | ID заявки |
| Request - | |
| Response ResponseEntity->byte |
Методы работы с субъектами
Заголовок раздела «Методы работы с субъектами»Метод поиска субъектов
Заголовок раздела «Метод поиска субъектов»| GET API – Поиск субъектов | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью “Оператор” или “Администратор” с использованием данного метода доступно получение данных любого субъекта подключенного eCA-CA. В ответе данного метода в поле “subjectName” атрибуты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия у субъекта будут указаны как “UNKNOWN”. Данные атрибуты поддерживаются в публичном API начиная с версии v3. | |
| URL – /middleware-service/api/v2/public/subjects | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20субъекты/findAll_2 | |
| Query | |
| id (UUID[]), [опционально | ID субъекта[28] |
| resourceId (UUID[]), [опционально | ID ресурсной системы |
| securityGroupId (UUID[]), [опционально | ID группы безопасности |
| search (string), [опционально | Полнотекстовый поиск (имя субъекта) |
| isConnected (boolean), [опционально | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), [опционально | Флаг: субъект заблокирован в ресурсной системе |
| pageLimit (integer), [опционально | Ограничение на размер выборки (пагинация) |
| pageOffset (integer), [опционально | Смещение от начала списка (пагинация) |
| sortBy (string[]), [опционально | Список полей, к которым применяется сортировка |
| sortDirection (string) [опционально | Направления сортировки (ASC;DESC) |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (UUID), | ID субъекта[29] |
| commonName (string), | Имя субъекта |
| distinguishedName (string), | Расположение субъекта в ресурсной системе |
| > resource: | Ресурсная система |
| id (uuid), | ID ресурсной системы |
| > commonName (string), | Имя ресурсной системы |
| distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
| subjectName: | Имя субъекта |
| > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): | Поля разделенного имени субъекта |
| > values (string[]), | Значения компонента |
| > editable (boolean), | Флаг: компонент доступен для редактирования |
| > | |
| subjectAltName: | Альтернативное имя субъекта |
| > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): | Поля альтернативного имени субъекта |
| > values (string[]), | Значения компонента |
| > editable (boolean), | Флаг: компонент доступен для редактирования |
| > | |
| isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
| modify (instant), | Время изменения (ISO 8601) |
| certificatesCount (integer), | Количество действующих сертификатов у субъекта |
| updated (instant), | Время обновления (ISO 8601) |
| > created (instant) | Время создания (ISO 8601) |
Метод получения субъекта по идентификатору
Заголовок раздела «Метод получения субъекта по идентификатору»| GET API – Получение субъекта по идентификатору | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью “Оператор” или “Администратор” с использованием данного метода доступно получение данных любого субъекта подключенного eCA-CA. В ответе данного метода в поле “subjectName” атрибуты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия у субъекта будут указаны как “UNKNOWN”. Данные атрибуты поддерживаются в публичном API начиная с версии v3. | |
| URL – /middleware-service/api/v2/public/subjects/{id | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20субъекты/findById_2 | |
| Query | |
| id (UUID) | ID субъекта[30] |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| id (UUID), | ID субъекта[31] |
| commonName (string), | Имя субъекта |
| distinguishedName (string), | Расположение субъекта в ресурсной системе |
| > resource: | Ресурсная система |
| id (uuid), | ID ресурсной системы |
| > commonName (string), | Имя ресурсной системы |
| distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
| subjectName: | Имя субъекта |
| > (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): | Поля разделенного имени субъекта |
| > values (string[]), | Значения компонента |
| > editable (boolean), | Флаг: компонент доступен для редактирования |
| > | |
| subjectAltName: | Альтернативное имя субъекта |
| > (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): | Поля альтернативного имени субъекта |
| > values (string[]), | Значения компонента |
| > editable (boolean), | Флаг: компонент доступен для редактирования |
| > | |
| isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
| isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
| modify (instant), | Время изменения (ISO 8601) |
| certificatesCount (integer), | Количество действующих сертификатов у субъекта |
| updated (instant), | Время обновления (ISO 8601) |
| > created (instant) | Время создания (ISO 8601) |
Методы работы с шаблонами
Заголовок раздела «Методы работы с шаблонами»Метод поиска шаблонов
Заголовок раздела «Метод поиска шаблонов»| GET API – Поиск шаблонов | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение только тех шаблонов, которые указаны в правилах выпуска с режимом обработки “Автоматический выпуск” или “Ручная обработка” для ассоциированного с текущей учетной записью субъекта. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение только тех шаблонов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение любых шаблонов. | |
| URL – /middleware-service/api/v2/public/templates | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20шаблоны/findAll_1 | |
| Query | |
| pageLimit (integer), [опционально | Ограничение на размер выборки (пагинация) |
| pageOffset (integer), [опционально | Смещение от начала списка (пагинация) |
| sortBy (string[]), [опционально | Список полей, к которым применяется сортировка |
| sortDirection (string), [опционально | Направления сортировки (ASC;DESC) |
| types (enum[]: EMBEDDED, CLONED, IMPORTED, UNKNOWN), [опционально | Тип шаблона |
| endEntityType (enum[]: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN) [опционально], | Тип субъекта |
| certificateType (enum[]: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), [опционально | Тип выпускаемого сертификата |
| search (string), [опционально | Полнотекстовый поиск по имени шаблона |
| removed (boolean), [опционально | Флаг: шаблон удален |
| id (UUID[]), [опционально | ID шаблона |
| notId (UUID[]), [опционально | Исключая ID шаблона |
| keyAlgorithm (enum[]: RSA, ECDSA, GOST_R_34_10_2012, UNKNOWN) [опционально | Фильтр: алгоритм ключа включен в шаблоне[32] |
| Request - | |
| Response ResponseEntity -> CollectionResponse -> | Ответ JSON в HTTP-body |
| id (UUID), | ID шаблона[33] |
| name (string), | Имя шаблона |
| type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), | Тип шаблона |
| certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип выпускаемого сертификата |
| certificateAuthorityId (UUID), | ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону. Шаблоны, у которых в поле “Центр сертификации” указано “Любой”, будут иметь в данном поле значение NULL. |
| endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), | Тип субъекта |
| certificateCount (int64), | Число выпущенных по шаблону сертификатов |
| removed (boolean), | Флаг: шаблон удален |
| updated (instant), | Время обновления (ISO 8601) |
| > created (instant) | Время создания (ISO 8601) |
Метод получения шаблона по идентификатору
Заголовок раздела «Метод получения шаблона по идентификатору»| GET API – Получение шаблона по идентификатору | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступно получение только тех шаблонов, которые указаны в правилах выпуска с режимом обработки “Автоматический выпуск” или “Ручная обработка” для ассоциированного с текущей учетной записью субъекта. Для УЗ с ролью “Оператор” с использованием данного метода доступно получение только тех шаблонов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступно получение любых шаблонов. В ответе данного метода в поле “subjectDN” компоненты “ROLE” (роль), “DATEOFBIRTH” (дата рождения) и “PLACEOFBIRTH” (место рождения) в случае их наличия в шаблоне будут указаны как “UNKNOWN”. Данные компоненты поддерживаются в публичном API начиная с версии v3. | |
| URL – /middleware-service/api/v2/public/templates/{id | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/Контроллер%3A%20шаблоны/findById_1 | |
| Query | |
| templateId (UUID) | ID шаблона[34] |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| id (UUID), | ID шаблона[35] |
| name (string), | Имя шаблона |
| validity (int64), | Время действия выпускаемого сертификата (мс) |
| certificateType (enum: CERTIFICATE, ROOT_CA, SUB_CA, UNKNOWN), | Тип выпускаемого сертификата |
| type (enum: EMBEDDED, CLONED, IMPORTED, UNKNOWN), | Тип шаблона |
| certificateAuthorityId (UUID), | ID ЦС, который должен использоваться при выпуске сертификата по данному шаблону Шаблоны, у которых в поле “Центр сертификации” указано “Любой”, будут иметь в данном поле значение NULL |
| endEntityType (enum: USER, DEVICE, ROOT_CA, SUB_CA, UNKNOWN), | Тип субъекта |
| removed (boolean), | Флаг: шаблон удален |
| rsa: | Описание RSA-криптографии |
| use (boolean), | Флаг: RSA-ключи доступны для шаблона |
| minLength (int32), | Минимальная длина RSA-ключа |
| lengths (int32[]) | Доступные длины RSA-ключа |
| ecdsa: | Описание ESDCA-криптографии |
| use (boolean), | Флаг: ESDCA -ключи доступны для шаблона |
| minLength (int32), | Минимальная длина ESDCA -ключа |
| lengths (int32[]) | Доступные длины ESDCA -ключа |
| gost: | Описание ГОСТ-криптографии |
| > use (boolean), | Флаг: ГОСТ -ключи доступны для шаблона |
| > minLength (int32), | Минимальная длина ГОСТ -ключа |
| > lengths (int32[]) | Доступные длины ГОСТ -ключа |
| keyUsages: | Назначение ключа сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (enum[]:DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, KEY_CERT_SIGN, CRL_SIGN, ENCIPHER_ONLY, DECIPHER_ONLY, UNKNOWN) | Значение расширения |
| extendedKeyUsages: | Расширенное назначение ключа сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (string[]) | Значение расширения (OIDs) |
| policies: | Политики сертификата |
| critical (boolean), | Флаг: расширение критическое |
| values (string[]) | Значение расширения (OIDs) |
| subjectDN: | Имя субъекта сертификата |
| index (int32), | Индекс (для сортировки, по умолчанию – 0) |
| name (string), | Имя компонента |
| description (string), | Описание компонента |
| required (boolean), | Флаг: обязателен к заполнению |
| validation (boolean), | Флаг: валидация значения |
| modifiable (boolean), | Флаг: доступен к редактированию |
| regex (string), | Регулярное значение для валидации значения |
| defaultValue (string), | Значение по умолчанию |
| alert (string), | Предупреждение о неудачной валидации значения |
| code (enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN) | Код компонента |
| subjectAltName: | Расширенное имя субъекта сертификата |
| index (int32), | Индекс (для сортировки, по умолчанию – 0) |
| name (string), | Имя компонента |
| description (string), | Описание компонента |
| required (boolean), | Флаг: обязателен к заполнению |
| validation (boolean), | Флаг: валидация значения |
| modifiable (boolean), | Флаг: доступен к редактированию |
| regex (string), | Регулярное значение для валидации значения |
| defaultValue (string), | Значение по умолчанию |
| alert (string), | Предупреждение о неудачной валидации значения |
| code (enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN), | Код компонента |
| generalName (int32), | Идентификатор компонента в RFC |
| oid (string) | OID компонента в RFC |
| updated (instant), | Время обновления (ISO 8601) |
| > created (instant) | Время создания (ISO 8601) |
Методы работы с сертификатами
Заголовок раздела «Методы работы с сертификатами»Метод отзыва сертификата по идентификатору заявки
Заголовок раздела «Метод отзыва сертификата по идентификатору заявки»| POST API – Отзыв сертификата по идентификатору заявки | |
|---|---|
| Для УЗ с ролью “Пользователь” с использованием данного метода доступен отзыв сертификатов только из тех заявок, получателем сертификата по которым является субъект, связанный с данной УЗ. Для УЗ с ролью “Оператор” с использованием данного метода доступен отзыв сертификатов из заявок для субъектов, доступ к которым данному оператору предоставлен по правилам доступа подключенного eCA-CA. Для УЗ с ролью “Администратор” с использованием данного метода доступен отзыв сертификатов из любых заявок. Для успешного получения сертификата из заявки она должна иметь статус “COMPLETED”. | |
| URL – /tasks-service/api/v2/public/tasks/{id}/certificate/revoke | |
| Swagger: | |
| Query | |
| > id (uuid) | ID заявки |
| Request | |
| > reason (enum: UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, AA_COMPROMISE, UNKNOWN), | Причина отзыва |
| > comment (string) | Комментарий |
| Response - |
Методы получения информации о сервисах
Заголовок раздела «Методы получения информации о сервисах»Методы получения информации о сервисе безопасности (security-service)
Заголовок раздела «Методы получения информации о сервисе безопасности (security-service)»Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе безопасности (security-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – security-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/security-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/security-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/security-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса безопасности (security-service)
Заголовок раздела «Метод получения информации о состоянии сервиса безопасности (security-service)»| GET – Получение информации о состоянии сервиса безопасности | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе безопасности | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе заявок (tasks-service)
Заголовок раздела «Методы получения информации о сервисе заявок (tasks-service)»Метод получения эндпоинтов для запроса информации о сервисе заявок (tasks-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе заявок (tasks-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – tasks-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/tasks-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/tasks-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/tasks-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/tasks-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/tasks-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса заявок (tasks -service)
Заголовок раздела «Метод получения информации о состоянии сервиса заявок (tasks -service)»| GET – Получение информации о состоянии сервиса заявок | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – tasks-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о сервисе заявок (tasks-service)
Заголовок раздела «Метод получения информации о сервисе заявок (tasks-service)»| GET – Получение информации о сервисе заявок | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – tasks-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик сервиса заявок (tasks-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса заявок (tasks-service)»| GET – Получение Prometheus-метрик сервиса заявок | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – tasks-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе журнала событий (logs-service)
Заголовок раздела «Методы получения информации о сервисе журнала событий (logs-service)»Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе журнала событий (logs-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – logs-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/logs-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/logs-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/logs-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса журнала событий (logs-service)
Заголовок раздела «Метод получения информации о состоянии сервиса журнала событий (logs-service)»| GET – Получение информации о состоянии сервиса журнала событий | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе журнала событий | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе правил выпуска (policies-service)
Заголовок раздела «Методы получения информации о сервисе правил выпуска (policies-service)»Метод получения эндпоинтов для запроса информации о сервисе правил выпуска (policies-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе правил выпуска (policies-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – policies-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/policies-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/policies-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/policies-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/policies-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/policies-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса правил выпуска (policies service)
Заголовок раздела «Метод получения информации о состоянии сервиса правил выпуска (policies service)»| GET – Получение информации о состоянии сервиса правил выпуска | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – policies-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о сервисе правил выпуска (policies-service)
Заголовок раздела «Метод получения информации о сервисе правил выпуска (policies-service)»| GET – Получение информации о сервисе правил выпуска | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – policies-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик сервиса правил выпуска (policies-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса правил выпуска (policies-service)»| GET – Получение Prometheus-метрик сервиса правил выпуска | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – policies-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Методы получения информации о сервисе интеграции с центром сертификации (ca-adapter-service)»Метод получения эндпоинтов для запроса информации о сервисе интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе интеграции с центром сертификации (ca-adapter-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о се | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – ca-adapter-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/ca-adapter-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/ca-adapter-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/ca-adapter-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса интеграции с центром сертификации (ca-adapter-service)
Заголовок раздела «Метод получения информации о состоянии сервиса интеграции с центром сертификации (ca-adapter-service)»| GET – Получение информации о состоянии сервиса интеграции с центром с | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе интеграции с центром сертификаци | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе настроек (settings-service)
Заголовок раздела «Методы получения информации о сервисе настроек (settings-service)»Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе настроек (settings-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – settings-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/settings-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/settings-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/settings-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса настроек (settings-service)
Заголовок раздела «Метод получения информации о состоянии сервиса настроек (settings-service)»| GET – Получение информации о состоянии сервиса настроек | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе настроек | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – settings-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик сервиса настроек (settings-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса настроек (settings-service)»| GET – Получение Prometheus-метрик сервиса настроек | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – settings-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе промежуточного взаимодействия (middleware-service)
Заголовок раздела «Методы получения информации о сервисе промежуточного взаимодействия (middleware-service)»Метод получения эндпоинтов для запроса информации о сервисе промежуточного взаимодействия (middleware-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе промежуточного взаимодействия (middleware-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о се | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – middleware-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/middleware-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/middleware-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/middleware-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/middleware-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/middleware-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса промежуточного взаимодействия (middleware-service)
Заголовок раздела «Метод получения информации о состоянии сервиса промежуточного взаимодействия (middleware-service)»| GET – Получение информации о состоянии сервиса промежуточного взаимод | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – middleware-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о сервисе промежуточного взаимодействия (middleware-service)
Заголовок раздела «Метод получения информации о сервисе промежуточного взаимодействия (middleware-service)»| GET – Получение информации о сервисе промежуточного взаимодействия | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – middleware-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик сервиса промежуточного взаимодействия (middleware-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса промежуточного взаимодействия (middleware-service)»| GET – Получение Prometheus-метрик сервиса промежуточного взаимодейств | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – middleware-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе хранения данных (storage-service)
Заголовок раздела «Методы получения информации о сервисе хранения данных (storage-service)»Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе хранения данных (storage-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – storage-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/storage-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/storage-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/storage-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса хранения данных (storage-service)
Заголовок раздела «Метод получения информации о состоянии сервиса хранения данных (storage-service)»| GET – Получение информации о состоянии сервиса хранения данных | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе хранения данных | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе экспорта данных (export-service)
Заголовок раздела «Методы получения информации о сервисе экспорта данных (export-service)»Метод получения эндпоинтов для запроса информации о сервисе экспорта данных (export-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе экспорта данных (export-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – export-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/export-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/export-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/export-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/export-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/export-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса экспорта данных (export-service)
Заголовок раздела «Метод получения информации о состоянии сервиса экспорта данных (export-service)»| GET – Получение информации о состоянии сервиса экспорта данных | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – export-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о сервисе экспорта данных (export-service)
Заголовок раздела «Метод получения информации о сервисе экспорта данных (export-service)»| GET – Получение информации о сервисе экспорта данных | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – export-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик сервиса экспорта данных (export-service)
Заголовок раздела «Метод получения Prometheus-метрик сервиса экспорта данных (export-service)»| GET – Получение Prometheus-метрик сервиса экспорта данных | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – export-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о SCEP-сервисе (scep-service)
Заголовок раздела «Методы получения информации о SCEP-сервисе (scep-service)»Метод получения эндпоинтов для запроса информации о SCEP-сервисе (scep-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о SCEP-сервисе (scep-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – scep-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/scep-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/scep-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/scep-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/scep-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/scep-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии SCEP-сервиса (scep -service)
Заголовок раздела «Метод получения информации о состоянии SCEP-сервиса (scep -service)»| GET – Получение информации о состоянии SCEP-сервиса | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – scep-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о SCEP-сервисе (scep -service)
Заголовок раздела «Метод получения информации о SCEP-сервисе (scep -service)»| GET – Получение информации о SCEP-сервисе | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – scep-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик SCEP-сервиса (scep -service)
Заголовок раздела «Метод получения Prometheus-метрик SCEP-сервиса (scep -service)»| GET – Получение Prometheus-метрик SCEP-сервиса | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – scep-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Методы получения информации о сервисе внешних интеграций (external-integration-service)»Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о сервисе внешних интеграций (external-integration-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о сервисе внеш | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – external-integration-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/external-integration-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/external-integration-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”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-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/external-integration-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)
Заголовок раздела «Метод получения информации о состоянии сервиса внешних интеграций (external-integration-service)»| GET – Получение информации о состоянии сервиса внешних интеграций | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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 – Получение информации о сервисе внешних интеграций | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| 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-метрик сервиса внешних интеграций (externa | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – external-integration-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Методы получения информации о WSTEP-сервисе (wstep-enrollment-service)
Заголовок раздела «Методы получения информации о WSTEP-сервисе (wstep-enrollment-service)»Метод получения эндпоинтов для запроса информации о WSTEP-сервисе (wstep-enrollment-service)
Заголовок раздела «Метод получения эндпоинтов для запроса информации о WSTEP-сервисе (wstep-enrollment-service)»| GET – Получение списка доступных эндпоинтов для запроса информации о WSTEP-се | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – wstep-enrollment-service/actuator | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| ”_links”: | |
| “self”: | |
“href”: “https://HOST/wstep-enrollment-service/actuator”, | URL эндпоинта, который возвращает эндпоинты для запроса информации о сервисе, где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health”: | |
“href”: “https://HOST/wstep-enrollment-service/actuator/health”, | URL эндпоинта, который возвращает информацию о состоянии сервиса (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”health-path”: | |
“href”: “https://HOST/wstep-enrollment-service/actuator/health/{*path}”, | URL зарезервированного эндроинта под будущие реализации |
| ”templated”: true | Флаг наличия переменной в URL |
| ”info”: | |
“href”: “https://HOST/wstep-enrollment-service/actuator/info”, | URL эндпоинта, который возвращает информацию о сервисе (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
| ”prometheus”: | |
“href”: “https://HOST/wstep-enrollment-service/actuator/prometheus”, | URL эндпоинта, который возвращает метрики сервиса в формате Prometheus (подробнее см. ниже), где HOST – адрес хоста eCA-RA |
| ”templated”: false | Флаг наличия переменной в URL |
Метод получения информации о состоянии WSTEP-сервисе (wstep-enrollment-service)
Заголовок раздела «Метод получения информации о состоянии WSTEP-сервисе (wstep-enrollment-service)»| GET – Получение информации о состоянии WSTEP-сервисе | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – wstep-enrollment-service/actuator/health | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > status (enum: UP, DOWN, OUT_OF_SERVICE, UNKNOWN) | Статус (состояние) сервиса безопасности. Возможные значения: - UP – работает; - DOWN – не работает; - OUT_OF_SERVICE – выключен; - UNKNOWN – нет информации. |
Метод получения информации о WSTEP-сервисе (wstep-enrollment-service)
Заголовок раздела «Метод получения информации о WSTEP-сервисе (wstep-enrollment-service)»| GET – Получение информации о WSTEP-сервисе | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – wstep-enrollment-service/actuator/info | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | Ответ JSON в HTTP-body |
| > “application”: | |
| > name (string) | Название сервиса |
| > version (string) | Версия сервиса |
| > |
Метод получения Prometheus-метрик WSTEP-сервиса (wstep-enrollment-service)
Заголовок раздела «Метод получения Prometheus-метрик WSTEP-сервиса (wstep-enrollment-service)»| GET – Получение Prometheus-метрик WSTEP-сервиса | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра “actuator_authenticate” конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
| URL – wstep-enrollment-service/actuator/prometheus | |
| Swagger: - | |
| Query - | |
| Request - | |
| Response | |
| Метод возвращает метрики сервиса в формате Prometheus (text/plain), описание которых приведено в Приложении Б. |
Описание Prometheus-метрик сервисов
Заголовок раздела «Описание Prometheus-метрик сервисов»Базовые метрики сервиса
Заголовок раздела «Базовые метрики сервиса»Время запуска:
- application_ready_time_seconds{main_application_class=”…”} gauge. Время, за которое сервис стал готов обслуживать запросы (в секундах). Метка “main_application_class” содержит имя основного класса сервиса.
- application_started_time_seconds{main_application_class=”…”} gauge. Время, затраченное на запуск сервиса (в секундах). Метка “main_application_class” содержит имя основного класса сервиса.
Метрики диска:
Заголовок раздела «Метрики диска:»- disk_free_bytes{path=”…”} gauge. Свободное место на диске, в котором располагается сервис (в байтах). Метка “path” указывает путь к сервису в файловой системе.
- disk_total_bytes{path=”…”} gauge. Общий объем диска, в котором располагается сервис (в байтах). Метка “path” указывает путь к сервису в файловой системе.
Метрики исполнителей (Thread Pools)
Заголовок раздела «Метрики исполнителей (Thread Pools)»taskExecutor (пул асинхронных задач):
- executor_active_threads{name=“taskExecutor”} gauge. Количество потоков, прямо сейчас выполняющих задачи.
- executor_completed_tasks_total{name=“taskExecutor”} counter. Сколько задач уже выполнено с момента запуска.
- executor_pool_core_threads{name=“taskExecutor”} gauge. Минимальное количество потоков, которое пул старается поддерживать.
- executor_pool_max_threads{name=“taskExecutor”} gauge. Максимальное количество потоков, которое может быть создано.
- executor_pool_size_threads{name=“taskExecutor”} gauge. Сколько потоков сейчас существует в пуле.
- executor_queue_remaining_tasks{name=“taskExecutor”} gauge. Количество свободных мест в очереди задач без блокировки.
- executor_queued_tasks{name=“taskExecutor”} gauge. Количество задач, ожидающих в очереди на выполнение.
taskScheduler (пул планировщика задач):
- executor_active_threads{name=“taskScheduler”} gauge. Количество потоков, прямо сейчас выполняющих запланированные задачи.
- executor_completed_tasks_total{name=“taskScheduler”} counter. Общее количество уже завершенных запланированных задач.
- executor_pool_core_threads{name=“taskScheduler”} gauge. Базовый (core) размер пула потоков.
- executor_pool_max_threads{name=“taskScheduler”} gauge. Максимально допустимый размер пула.
- executor_pool_size_threads{name=“taskScheduler”} gauge. Текущее количество потоков в пуле.
- executor_queue_remaining_tasks{name=“taskScheduler”} gauge. Количество свободных мест в очереди запланированных задач.
- executor_queued_tasks{name=“taskScheduler”} gauge. Количество задач, ожидающих в очереди на выполнение.
Метрики пула подключений к БД (HikariCP)
Заголовок раздела «Метрики пула подключений к БД (HikariCP)»Основные метрики пула:
- hikaricp_connections{pool=”…”} gauge. Общее количество подключений в пуле.
- hikaricp_connections_acquire_seconds_count{pool=”…”} counter. Количество операций получения подключения из пула.
- hikaricp_connections_acquire_seconds_sum{pool=”…”} counter. Суммарное время получения подключений (в секундах).
- hikaricp_connections_acquire_seconds_max{pool=”…”} gauge. Максимальное время получения подключения (в секундах).
- hikaricp_connections_active{pool=”…”} gauge. Количество активных подключений.
- hikaricp_connections_creation_seconds_count{pool=”…”} counter. Количество созданных подключений.
- hikaricp_connections_creation_seconds_sum{pool=”…”} counter. Суммарное время создания подключений (в секундах).
- hikaricp_connections_creation_seconds_max{pool=”…”} gauge. Максимальное время создания подключения (в секундах).
- hikaricp_connections_idle{pool=”…”} gauge. Количество простаивающих подключений.
- hikaricp_connections_max{pool=”…”} gauge. Максимальный размер пула.
- hikaricp_connections_min{pool=”…”} gauge. Минимальный размер пула.
- hikaricp_connections_pending{pool=”…”} gauge. Количество потоков, ожидающих подключение.
- hikaricp_connections_timeout_total{pool=”…”} counter. Количество таймаутов при получении подключения.
- hikaricp_connections_usage_seconds_count{pool=”…”} counter. Количество операций использования подключений.
- hikaricp_connections_usage_seconds_sum{pool=”…”} counter. Суммарное время использования подключений (в секундах).
- hikaricp_connections_usage_seconds_max{pool=”…”} gauge. Максимальное время использования одного подключения (в секундах).
5 Метрики HTTP-клиента
Заголовок раздела «5 Метрики HTTP-клиента»Активные клиентские запросы:
- http_client_requests_active_seconds_count{client_name=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Количество активных исходящих запросов.
- http_client_requests_active_seconds_sum{client_name=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Суммарное время активных исходящих запросов.
- http_client_requests_active_seconds_max{client_name=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} gauge. Максимальное время активного исходящего запроса.
Завершенные клиентские запросы:
- http_client_requests_seconds_count{client_name=”…”, error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Количество исходящих HTTP-запросов.
- http_client_requests_seconds_sum{client_name=”…”, error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Суммарное время выполнения исходящих запросов (в секундах).
- http_client_requests_seconds_max{client_name=”…”, error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} gauge. Максимальное время выполнения исходящего запроса.
Метрики HTTP-сервера
Заголовок раздела «Метрики HTTP-сервера»Активные серверные запросы:
- http_server_requests_active_seconds_count{exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Количество активных входящих запросов.
- http_server_requests_active_seconds_sum{exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Суммарное время активных запросов.
- http_server_requests_active_seconds_max{exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} gauge. Максимальное время активного запроса.
Завершённые серверные запросы:
- http_server_requests_seconds_count{error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Количество входящих HTTP-запросов.
- http_server_requests_seconds_sum{error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} counter. Суммарное время обработки входящих запросов (в секундах).
- http_server_requests_seconds_max{error=”…”, exception=”…”, method=”…”, outcome=”…”, status=”…”, uri=”…”} gauge. Максимальное время обработки входящего запроса (в секундах).
JDBC-метрики (альтернативное представление HikariCP):
Заголовок раздела «JDBC-метрики (альтернативное представление HikariCP):»- jdbc_connections_active{name=“dataSource”} gauge. Количество активных подключений.
- jdbc_connections_idle{name=“dataSource”} gauge. Количество простаивающих подключений.
- jdbc_connections_max{name=“dataSource”} gauge. Максимальный размер пула.
- jdbc_connections_min{name=“dataSource”} gauge. Минимальный размер пула.
Метрики JVM (Java Virtual Machine)
Заголовок раздела «Метрики JVM (Java Virtual Machine)»Общая информация:
- jvm_info{runtime=”…”, vendor=”…”, version=”…”} gauge. Информация о версии JVM (значение всегда 1, метки содержат детали).
Буферы:
- jvm_buffer_count_buffers{id=”…”} gauge. Количество буферов в пуле. Метка id указывает тип буфера (direct или mapped).
- jvm_buffer_memory_used_bytes{id=”…”} gauge. Память, используемая буферами (в байтах).
- jvm_buffer_total_capacity_bytes{id=”…”} gauge. Общая емкость буферов (в байтах).
Классы:
- jvm_classes_loaded_classes gauge. Количество загруженных классов.
- jvm_classes_unloaded_classes_total counter. Общее количество выгруженных классов.
Компиляция:
- jvm_compilation_time_ms_total{compiler=”…”} counter. Общее время, затраченное на JIT-компиляцию (в миллисекундах).
Сборка мусора:
- jvm_gc_live_data_size_bytes gauge. Размер данных в long-lived heap после последней сборки мусора.
- jvm_gc_max_data_size_bytes gauge. Максимальный размер “долгоживущей” области (Old Generation) в байтах.
- jvm_gc_memory_allocated_bytes_total counter. Объем памяти, выделенной в молодом поколении после сборки мусора.
- jvm_gc_memory_promoted_bytes_total counter. Объем памяти, продвинутой из молодого поколения в старое.
- jvm_gc_overhead gauge. Процент времени CPU, затраченного на сборку мусора (значение от 0 до 1).
Память (выделенная):
- jvm_memory_committed_bytes{area=”…”, id=”…”} gauge. Объем памяти, гарантированно доступный JVM (в байтах). Метка area указывает область (heap или nonheap), метка id указывает конкретный пул памяти.
Память (максимальная):
- jvm_memory_max_bytes{area=”…”, id=”…”} gauge. Максимальный объем памяти, который может использовать JVM (в байтах).
Память (после сборки мусора):
- jvm_memory_usage_after_gc{area=“heap”, pool=“long-lived”} gauge. Процент использования long-lived области после последней сборки мусора (значение от 0 до 1).
Память (используемая):
- jvm_memory_used_bytes{area=”…”, id=”…”} gauge. Используемая память (в байтах) по областям heap и non-heap.
Потоки:
- jvm_threads_daemon_threads gauge. Количество потоков-демонов.
- jvm_threads_live_threads gauge. Текущее количество живых потоков.
- jvm_threads_peak_threads gauge. Пиковое количество потоков с момента запуска.
- jvm_threads_started_threads_total counter. Общее количество запущенных потоков.
- jvm_threads_states_threads{state=”…”} gauge. Количество потоков в каждом состоянии (runnable, waiting, timed-waiting, blocked, new, terminated).
Метрики логирования (Logback):
Заголовок раздела «Метрики логирования (Logback):»- logback_events_total{level=”…”} counter. Количество событий лога по уровням: debug, error, info, trace, warn.
Метрики процесса:
Заголовок раздела «Метрики процесса:»- process_cpu_time_ns_total counter. Процессорное время, использованное процессом JVM (в наносекундах).
- process_cpu_usage gauge. Загрузка ЦП процессом JVM (значение от 0 до 1).
- process_files_max_files gauge. Максимальное количество файловых дескрипторов.
- process_files_open_files gauge. Количество открытых файловых дескрипторов.
- process_start_time_seconds gauge. Время запуска процесса в формате Unix timestamp.
- process_uptime_seconds gauge. Время работы процесса с момента запуска (в секундах).
Метрики Spring Data Repository:
Заголовок раздела «Метрики Spring Data Repository:»- spring_data_repository_invocations_seconds_count{exception=”…”, method=”…”, repository=”…”, state=”…”} counter. Количество вызовов методов репозиториев.
- spring_data_repository_invocations_seconds_sum{exception=”…”, method=”…”, repository=”…”, state=”…”} counter. Суммарное время выполнения методов репозиториев (в секундах).
- spring_data_repository_invocations_seconds_max{exception=”…”, method=”…”, repository=”…”, state=”…”} gauge. Максимальное время выполнения метода репозитория (в секундах).
Метрики безопасности (Spring Security)
Заголовок раздела «Метрики безопасности (Spring Security)»Активная авторизация:
- spring_security_authorizations_active_seconds_count{spring_security_authentication_type=”…”, spring_security_authorization_decision=”…”, spring_security_object=”…”} counter. Количество активных проверок авторизации.
- spring_security_authorizations_active_seconds_sum{…} counter. Суммарное время активных проверок (в секундах).
- spring_security_authorizations_active_seconds_max{…} gauge. Максимальное время активной проверки.
Завершенная авторизация:
- spring_security_authorizations_seconds_count{error=”…”, spring_security_authentication_type=”…”, spring_security_authorization_decision=”…”, spring_security_object=”…”} counter. Количество проверок авторизации.
- spring_security_authorizations_seconds_sum{…} counter. Суммарное время проверок авторизации (в секундах).
- spring_security_authorizations_seconds_max{…} gauge. Максимальное время проверки авторизации.
Счетчики прохождения фильтров безопасности (часть 1):
- spring_security_filterchains_[FilterName]_after_total{security_security_reached_filter_section=“after”, spring_security_filterchain_position=”…”, spring_security_filterchain_size=”…”, spring_security_reached_filter_name=“none”} counter. Количество запросов, прошедших после выполнения фильтра.
- spring_security_filterchains_[FilterName]_before_total{security_security_reached_filter_section=“before”, spring_security_filterchain_position=”…”, spring_security_filterchain_size=”…”, spring_security_reached_filter_name=“none”} counter. Количество запросов, прошедших перед выполнением фильтра.
Примечание: [FilterName] заменяется на имя конкретного фильтра (например, AecaAuthenticationExceptionFilter, ApiKeyAuthenticationFilter, UserPrincipalAuthenticationFilter и др.). Набор фильтров зависит от конфигурации безопасности конкретного сервиса.
Активные фильтры безопасности:
- spring_security_filterchains_active_seconds_count{security_security_reached_filter_section=”…”, spring_security_filterchain_position=”…”, spring_security_filterchain_size=”…”, spring_security_reached_filter_name=”…”} counter. Количество активных выполнений фильтров безопасности.
- spring_security_filterchains_active_seconds_sum{…} counter. Суммарное время активных выполнений фильтров (в секундах).
- spring_security_filterchains_active_seconds_max{…} gauge. Максимальное время активного выполнения фильтра.
Счетчики прохождения фильтров безопасности (часть 2):
- spring_security_filterchains_authentication_anonymous_after_total{…} counter. Количество прохождений после фильтра authentication_anonymous.
- spring_security_filterchains_authentication_anonymous_before_total{…} counter. Количество прохождений перед фильтром authentication_anonymous.
- spring_security_filterchains_authorization_after_total{…} counter. Количество прохождений после фильтра authorization.
- spring_security_filterchains_authorization_before_total{…} counter. Количество прохождений перед фильтром authorization.
- spring_security_filterchains_context_async_after_total{…} counter. Количество прохождений после фильтра context_async.
- spring_security_filterchains_context_async_before_total{…} counter. Количество прохождений перед фильтром context_async.
- spring_security_filterchains_context_holder_after_total{…} counter. Количество прохождений после фильтра context_holder.
- spring_security_filterchains_context_holder_before_total{…} counter. Количество прохождений перед фильтром context_holder.
- spring_security_filterchains_context_servlet_after_total{…} counter. Количество прохождений после фильтра context_servlet.
- spring_security_filterchains_context_servlet_before_total{…} counter. Количество прохождений перед фильтром context_servlet.
- spring_security_filterchains_header_after_total{…} counter. Количество прохождений после фильтра header.
- spring_security_filterchains_header_before_total{…} counter. Количество прохождений перед фильтром header.
- spring_security_filterchains_logout_after_total{…} counter. Количество прохождений после фильтра logout.
- spring_security_filterchains_logout_before_total{…} counter. Количество прохождений перед фильтром logout.
- spring_security_filterchains_requestcache_after_total{…} counter. Количество прохождений после фильтра requestcache.
- spring_security_filterchains_requestcache_before_total{…} counter. Количество прохождений перед фильтром requestcache.
Время выполнения фильтров:
- spring_security_filterchains_seconds_count{error=”…”, security_security_reached_filter_section=”…”, spring_security_filterchain_position=”…”, spring_security_filterchain_size=”…”, spring_security_reached_filter_name=”…”} counter. Количество выполнений фильтров безопасности.
- spring_security_filterchains_seconds_sum{…} counter. Суммарное время выполнения фильтров (в секундах).
- spring_security_filterchains_seconds_max{…} gauge. Максимальное время выполнения фильтра (в секундах).
Счетчики прохождения фильтров безопасности (часть 3):
- spring_security_filterchains_session_management_after_total{…} counter. Количество прохождений после фильтра session_management.
- spring_security_filterchains_session_management_before_total{…} counter. Количество прохождений перед фильтром session_management.
- spring_security_filterchains_session_urlencoding_after_total{…} counter. Количество прохождений после фильтра session_urlencoding.
- spring_security_filterchains_session_urlencoding_before_total{…} counter. Количество прохождений перед фильтром session_urlencoding.
Защищенные запросы:
- spring_security_http_secured_requests_active_seconds_count counter. Количество активных защищенных запросов.
- spring_security_http_secured_requests_active_seconds_sum counter. Суммарное время активных защищенных запросов (в секундах).
- spring_security_http_secured_requests_active_seconds_max gauge. Максимальное время активного защищенного запроса.
- spring_security_http_secured_requests_seconds_count{error=”…”} counter. Количество защищенных HTTP-запросов.
- spring_security_http_secured_requests_seconds_sum{error=”…”} counter. Суммарное время обработки защищенных запросов (в секундах).
- spring_security_http_secured_requests_seconds_max{error=”…”} gauge. Максимальное время обработки защищенного запроса.
Незащищенные запросы:
- spring_security_http_unsecured_requests_active_seconds_count counter. Количество активных незащищенных запросов.
- spring_security_http_unsecured_requests_active_seconds_sum counter. Суммарное время активных незащищенных запросов (в секундах).
- spring_security_http_unsecured_requests_active_seconds_max gauge. Максимальное время активного незащищенного запроса.
- spring_security_http_unsecured_requests_seconds_count{error=”…”} counter. Количество незащищенных HTTP-запросов.
- spring_security_http_unsecured_requests_seconds_sum{error=”…”} counter. Суммарное время обработки незащищенных запросов (в секундах).
- spring_security_http_unsecured_requests_seconds_max{error=”…”} gauge. Максимальное время обработки незащищенного запроса.
Системные метрики CPU:
Заголовок раздела «Системные метрики CPU:»- system_cpu_count gauge. Количество процессоров/ядер, доступных JVM.
- system_cpu_usage gauge. Общая загрузка ЦП системы (значение от 0 до 1).
- system_load_average_1m gauge. Средняя нагрузка на систему за 1 минуту.
Метрики планировщика задач
Заголовок раздела «Метрики планировщика задач»Активные задачи:
- tasks_scheduled_execution_active_seconds_count{code_function=”…”, code_namespace=”…”, exception=”…”, outcome=”…”} counter. Количество активных выполнений запланированных задач.
- tasks_scheduled_execution_active_seconds_sum{…} counter. Суммарное время активных выполнений.
- tasks_scheduled_execution_active_seconds_max{…} gauge. Максимальное время активного выполнения.
Завершенные задачи:
- tasks_scheduled_execution_seconds_count{code_function=”…”, code_namespace=”…”, error=”…”, exception=”…”, outcome=”…”} counter. Количество выполнений запланированных задач.
- tasks_scheduled_execution_seconds_sum{…} counter. Суммарное время выполнения запланированных задач (в секундах).
- tasks_scheduled_execution_seconds_max{…} gauge. Максимальное время выполнения запланированной задачи.
Метрики Tomcat-сессий:
Заголовок раздела «Метрики Tomcat-сессий:»- tomcat_sessions_active_current_sessions gauge. Текущее количество активных HTTP-сессий.
- tomcat_sessions_active_max_sessions gauge. Максимальное количество одновременных активных сессий.
- tomcat_sessions_alive_max_seconds gauge. Максимальное время жизни сессии.
- tomcat_sessions_created_sessions_total counter. Общее количество созданных сессий.
- tomcat_sessions_expired_sessions_total counter. Количество истекших сессий.
- tomcat_sessions_rejected_sessions_total counter. Количество отклоненных сессий.
Метод получения версии сервиса внешних интеграций
Заголовок раздела «Метод получения версии сервиса внешних интеграций»| GET API – Получение версии сервиса внешних интеграций | |
|---|---|
| Доступность метода для неаутентифицированного пользователя зависит от значения параметра actuator_authenticate конфигурационного файла: - если параметр имеет значение “true”, доступ к методу будет разрешен только аутентифицированным пользователям - если параметр имеет значение “false” (по умолчанию), доступ к методу будет разрешен без аутентификации. | |
Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/ | |
| URL – external-integration-service/api/version | |
| Query - | |
| Request - | |
| Response ResponseEntity -> ItemResponse -> | Ответ JSON в HTTP-body |
| > version (string) | Версия сервиса внешних интеграций |
[1]. В случае, если во входных параметрах метода создания заявки не указан ID субъекта и не найден субъект по CN, указанному во входных параметрах метода. ↑
[2]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[3]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[4]. При указании в поле “foreignKey” значения, аналогичного значению в поле “foreignKey” у уже существующей в базе данных программы заявки, при использовании метода будет возвращена ошибка с кодом 400. ↑
[5]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[6]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[7]. В случае, если во входных параметрах метода создания заявки не указан ID субъекта и не найден субъект по CN, указанному во входных параметрах метода. ↑
[8]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[9]. Если при создании администратором заявки на сертификат на основании запроса во входных параметрах метода не указан subjectId, ПО eCA-RA должно на основании указанного в запросе значения Common name автоматически определять (или создавать) получателя сертификата по заявке в соответствии со следующими правилами: • если в списке субъектов присутствует один субъект, имеющий Common name аналогичный указанному в запросе, получателем сертификата по заявке должен считаться данный субъект; • если в списке субъектов присутствует несколько субъектов, имеющих Common name аналогичный указанному в запросе, получателем сертификата по заявке из данного перечня субъектов должен считаться субъект с самой поздней датой последнего редактирования; • если в списке субъектов отсутствуют субъекты, имеющие Common name аналогичный указанному в запросе, eCA-RA должно создавать в eCA-СA локальный субъект на основании запроса. ↑
[10]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[11]. При указании в поле “foreignKey” значения, аналогичного значению в поле “foreignKey” у уже существующей в базе данных программы заявки, при использовании метода будет возвращена ошибка с кодом 400. ↑
[12]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[13]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[14]. В случае, если во входных параметрах метода создания заявки не указан ID субъекта и не найден субъект по CN, указанному во входных параметрах метода. ↑
[15]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[16]. Если при создании администратором заявки на сертификат на основании запроса во входных параметрах метода не указан subjectId, ПО eCA-RA должно на основании указанного в запросе значения Common name автоматически определять (или создавать) получателя сертификата по заявке в соответствии со следующими правилами: • если в списке субъектов присутствует один субъект, имеющий Common name аналогичный указанному в запросе, получателем сертификата по заявке должен считаться данный субъект; • если в списке субъектов присутствует несколько субъектов, имеющих Common name аналогичный указанному в запросе, получателем сертификата по заявке из данного перечня субъектов должен считаться субъект с самой поздней датой последнего редактирования; • если в списке субъектов отсутствуют субъекты, имеющие Common name аналогичный указанному в запросе, eCA-RA должно создавать в eCA-СA локальный субъект на основании запроса. ↑
[17]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[18]. При указании в поле “foreignKey” значения, аналогичного значению в поле “foreignKey” у уже существующей в базе данных программы заявки, при использовании метода будет возвращена ошибка с кодом 400. ↑
[19]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[20]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[21]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[22]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[23]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[24]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[25]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[26]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[27]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[28]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[29]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[30]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[31]. Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[32]. В случае использования множественных значений для фильтра “keyAlgorithm” в ответе метода будут содержаться шаблоны, в которых включен хотя бы один алгоритм из перечня, указанного в данном фильтре. ↑
[33]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[34]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑
[35]. Шаблоны eCA-CA и eCA-RA имеют сквозную идентификацию. ↑