Информация об SSL-сертификате кластера: различия между версиями

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

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / SSL-сертификаты / Информация об SSL-сертификате кластера

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

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

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

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

/api/v1.0/onpremise/sslCertificate

Параметры

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

Ответ

Коды ответа

Код	Тип	Описание
200	SSLDetails	Успех
500		Внутренняя ошибка сервера.

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

Объект `SSLDetails`

Элемент	Тип	Описание
customKeyStore	boolean	-
restartRequired	boolean	-
customKeyStoreWritable	boolean	-
inProgress	boolean	-
expirationDate	string	-
issuer	string	-
subject	string	-
default	boolean	-

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

<{
  "customKeyStore": true,
  "restartRequired": true,
  "customKeyStoreWritable": true,
  "inProgress": true,
  "expirationDate": "string",
  "issuer": "string",
  "subject": "string",
  "default": true
}

Пример

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

Curl

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

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

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

Тело ответа

<{
  "issuer": "EV SSL Intermediate CA RSA",
  "subject": "n32.myАппОптима.cluster.com",
  "expirationDate": 1615956886000,
  "customKeyStore": false,
  "customKeyStoreWritable": true,
  "inProgress": false,
  "restartRequired": false,
  "default": false
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|SSL-сертификаты]] / Информация об SSL-сертификате кластера'''''
 Этот вызов API извлекает сведения об SSL-сертификате кластера.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение 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</code>
@@ Строка 80: / Строка 82: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "customKeyStore": true,
     "restartRequired": true,
@@ Строка 89: / Строка 91: @@
     "subject": "string",
     "default": true
-  }</code>
+  }
 ==Пример==
-В этом примере вы проверяете сведения о сертификате SSL на ноде <code>№32</code> кластера <code>myManaged.cluster.com</code>. Взамен вы получаете информацию о текущем SSL-сертификате.
+В этом примере вы проверяете сведения о сертификате SSL на ноде <code>№32</code> кластера <code>myАппОптима.cluster.com</code>. Взамен вы получаете информацию о текущем SSL-сертификате.
 ====Curl====
-  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/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/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/SERVER/32</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "issuer": "EV SSL Intermediate CA RSA",
-    "subject": "n32.myManaged.cluster.com",
+    "subject": "n32.myАппОптима.cluster.com",
     "expirationDate": 1615956886000,
     "customKeyStore": false,
@@ Строка 106: / Строка 108: @@
     "restartRequired": false,
     "default": false
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>