ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
''''' | '''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / SSL-сертификаты / Информация об SSL-сертификате кластера''''' | ||
Этот вызов API извлекает сведения об SSL-сертификате кластера. | Этот вызов API извлекает сведения об SSL-сертификате кластера. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/v1.0/onpremise/sslCertificate</code> | <code>/api/v1.0/onpremise/sslCertificate</code> | ||
| Строка 82: | Строка 82: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"customKeyStore": true, | "customKeyStore": true, | ||
"restartRequired": true, | "restartRequired": true, | ||
| Строка 99: | Строка 99: | ||
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32</nowiki></code> | <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <{ | ||
"issuer": "EV SSL Intermediate CA RSA", | "issuer": "EV SSL Intermediate CA RSA", | ||
"subject": "n32.myManaged.cluster.com", | "subject": "n32.myManaged.cluster.com", | ||
Версия от 13:23, 8 ноября 2024
Установка и настройка / Основные элементы АппОптима / АппОптима Managed / 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 кластера myManaged.cluster.com. Взамен вы получаете информацию о текущем SSL-сертификате.
Curl
curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32" -H "accept: application/json" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"
URL-адрес запроса
https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32
Тело ответа
<{
"issuer": "EV SSL Intermediate CA RSA",
"subject": "n32.myManaged.cluster.com",
"expirationDate": 1615956886000,
"customKeyStore": false,
"customKeyStoreWritable": true,
"inProgress": false,
"restartRequired": false,
"default": false
}
Код ответа
200