Статус хранилища SSL-сертификата кластера: различия между версиями

Текущая версия от 15:54, 6 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / SSL-сертификаты / Статус хранилища SSL-сертификата кластера

Этот вызов API извлекает состояние хранилища SSL-сертификата кластера.

BAD_REQUEST

Состояние хранилища сертификата доступно только во время обновления или загрузки сертификата. После загрузки сертификата и перезапуска узла этот вызов API вернет BAD_REQUEST, поскольку состояние хранилища недоступно.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/v1.0/onpremise/sslCertificate/store

Параметры

Параметр	Тип	Описание	В	Обязательно
entityType	string	тип объекта (`COLLECTOR`, `SERVER`)	path	Да
entityId	integer	Идентификатор узла, который можно извлечь из URL-адреса в представлении «Сведения об узле».	path	Да

Ответ

Коды ответа

Код	Тип	Описание
200	CertificateStoreStatus	Успешно или в процессе
400	CertificateStoreStatus	Неверный тип объекта
404	CertificateStoreStatus	Статус не найден
500		Внутренняя ошибка
522	CertificateStoreStatus	Цепочка сертификатов недействительна.
523	CertificateStoreStatus	Закрытый ключ не соответствует сертификату открытого ключа
525	CertificateStoreStatus	Сертификат открытого ключа недействителен
526	CertificateStoreStatus	Закрытый ключ недействителен
527	CertificateStoreStatus	Ошибка при сохранении SSL-сертификата
528	CertificateStoreStatus	Сертификат сохранен, но не обновлен
529	CertificateStoreStatus	Внутренняя ошибка

Объекты тела ответа

Объект `CertificateStoreStatus`

Элемент	Тип	Описание
certificateStoreStatus	string	Может иметь значения: `BAD_REQUEST` `CERTIFICATE_CHAIN_IS_INVALID` `CERTIFICATE_IS_EXPIRED` `CERTIFICATE_STORED_BUT_NOT_REFRESHED` `ERROR` `GENERAL_ERROR_WHILE_STORING_CERTIFICATE` `IN_PROGRESS` `NOT_FOUND` `OK` `PRIVATE_KEY_DOES_NOT_MATCH_PUBLIC_KEY_CERTIFICATE` `PRIVATE_KEY_IS_INVALID` `PUBLIC_KEY_CERTIFICATE_IS_INVALID`
detailedError	string	-

JSON-модель тела ответа

<{
  "certificateStoreStatus": "BAD_REQUEST",
  "detailedError": "string"
}

Пример

В этом примере вы проверяете состояние хранилища сертификатов SSL на узле №32 кластера myАппОптима.cluster.com. В ответ вы получаете информацию о состоянии хранения SSL-сертификата, указывающую, что SSL-сертификат был успешно сохранен.

Curl

curl -X GET "https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32" -H  "accept: application/json" -H  "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"

URL-адрес запроса

https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32

Тело ответа

<{
  "certificateStoreStatus": "Successful",
  "detailedError": null
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|SSL-сертификаты]] / Статус хранилища SSL-сертификата кластера'''''
 Этот вызов API извлекает состояние хранилища SSL-сертификата кластера.
@@ Строка 5: / Строка 7: @@
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/v1.0/onpremise/sslCertificate/store</code>
@@ Строка 109: / Строка 111: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "certificateStoreStatus": "BAD_REQUEST",
     "detailedError": "string"
-  }</code>
+  }
 ==Пример==
-В этом примере вы проверяете состояние хранилища сертификатов SSL на узле <code>№32</code> кластера <code>myManaged.cluster.com</code>. В ответ вы получаете информацию о состоянии хранения SSL-сертификата, указывающую, что SSL-сертификат был успешно сохранен.
+В этом примере вы проверяете состояние хранилища сертификатов SSL на узле <code>№32</code> кластера <code>myАппОптима.cluster.com</code>. В ответ вы получаете информацию о состоянии хранения SSL-сертификата, указывающую, что SSL-сертификат был успешно сохранен.
 ====Curl====
-  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki>" -H  "accept: application/json" -H  "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"</code>
+  <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki>" -H  "accept: application/json" -H  "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "certificateStoreStatus": "Successful",
     "detailedError": null
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>