Хранение SSL-сертификата кластера - История изменений

IKuznetsov в 15:54, 6 января 2025

2025-01-06T15:54:22Z

← Предыдущая версия		Версия от 15:54, 6 января 2025
Строка 1:		Строка 1:
	'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / SSL-сертификаты / Хранение SSL-сертификата кластера'''''		'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима\|REST API]] / [[API Кластера v1]] / [[API Кластера v1\|SSL-сертификаты]] / Хранение SSL-сертификата кластера'''''

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

IKuznetsov в 21:11, 25 декабря 2024

2024-12-25T21:11:02Z

← Предыдущая версия		Версия от 21:11, 25 декабря 2024
Строка 1:		Строка 1:
	'''''Установка и настройка / Основные элементы АппОптима / АппОптима ~~Managed~~ / REST API / API Кластера v1 / SSL-сертификаты / Хранение SSL-сертификата кластера'''''		'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / SSL-сертификаты / Хранение SSL-сертификата кластера'''''

	Этот вызов API сохраняет SSL-сертификат кластера.		Этот вызов API сохраняет SSL-сертификат кластера.
Строка 65:		Строка 65:
	"publicKeyCertificateEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----",		"publicKeyCertificateEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----",
	"certificateChainEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDKT...bXTK+M\n-----END CERTIFICATE-----"		"certificateChainEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDKT...bXTK+M\n-----END CERTIFICATE-----"
	}~~</code>~~		}

	==Ответ==		==Ответ==
Строка 149:		Строка 149:
	"certificateStoreStatus": "BAD_REQUEST",		"certificateStoreStatus": "BAD_REQUEST",
	"detailedError": "string"		"detailedError": "string"
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере вы храните сертификат SSL на ноде <code>№32</code> кластера <code>~~myManaged~~.cluster.com</code>. В ответ вы получаете информацию о том, что SSL-сертификат был успешно обновлен. Убедитесь, что ваш запрос в формате JSON. Это означает, что объекты <code>privateKeyEncoded</code>, <code>publicKeyCertificateEncoded</code> и <code>certificateChainEncoded</code> находятся в одной строке.		В этом примере вы храните сертификат SSL на ноде <code>№32</code> кластера <code>myАппОптима.cluster.com</code>. В ответ вы получаете информацию о том, что SSL-сертификат был успешно обновлен. Убедитесь, что ваш запрос в формате JSON. Это означает, что объекты <code>privateKeyEncoded</code>, <code>publicKeyCertificateEncoded</code> и <code>certificateChainEncoded</code> находятся в одной строке.
	====Curl====		====Curl====
	<code>curl -X POST "<nowiki>https://~~myManaged~~.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki>" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"privateKeyEncoded\":\"-----BEGIN RSA PRIVATE KEY-----\MIIEow...aHzMvp\-----END RSA PRIVATE KEY-----\",\"publicKeyCertificateEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\",\"certificateChainEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\-----BEGIN CERTIFICATE-----\MIIDKT...bXTK+M\-----END CERTIFICATE-----\"}"</code>		<code>curl -X POST "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki>" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"privateKeyEncoded\":\"-----BEGIN RSA PRIVATE KEY-----\MIIEow...aHzMvp\-----END RSA PRIVATE KEY-----\",\"publicKeyCertificateEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\",\"certificateChainEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\-----BEGIN CERTIFICATE-----\MIIDKT...bXTK+M\-----END CERTIFICATE-----\"}"</code>
	====URL-адрес запроса====		====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>Успешно обновлено. Ответ не имеет тела.</code>		<code>Успешно обновлено. Ответ не имеет тела.</code>

IKuznetsov в 13:23, 8 ноября 2024

2024-11-08T13:23:49Z

← Предыдущая версия		Версия от 13:23, 8 ноября 2024
Строка 1:		Строка 1:
	'''''~~[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0~~ Установка и настройка~~] / [https://doc.ruscomtech.ru/index.php~~/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы ~~Ключ-Астром] / [https://doc.ruscomtech.ru/index.php~~/~~%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ~~ Managed] / ~~[https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API~~ REST API~~] / [https:/~~/~~doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1~~ API Кластера v1~~] / [https:/~~/~~doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1#SSL-.D1.81.D0.B5.D1.80.D1.82.D0.B8.D1.84.D0.B8.D0.BA.D0.B0.D1.82.D1.8B~~ SSL-сертификаты] / Хранение SSL-сертификата кластера'''''		'''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / SSL-сертификаты / Хранение SSL-сертификата кластера'''''

	Этот вызов API сохраняет 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/store</code>		<code>/api/v1.0/onpremise/sslCertificate/store</code>
Строка 61:		Строка 61:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"privateKeyEncoded": "-----BEGIN RSA PRIVATE KEY-----\nMIIEow...aHzMvp\n-----END RSA PRIVATE KEY-----",		"privateKeyEncoded": "-----BEGIN RSA PRIVATE KEY-----\nMIIEow...aHzMvp\n-----END RSA PRIVATE KEY-----",
	"publicKeyCertificateEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----",		"publicKeyCertificateEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----",
Строка 146:		Строка 146:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"certificateStoreStatus": "BAD_REQUEST",		"certificateStoreStatus": "BAD_REQUEST",
	"detailedError": "string"		"detailedError": "string"

ENetrebin в 14:12, 18 августа 2023

2023-08-18T14:12:37Z

← Предыдущая версия		Версия от 14:12, 18 августа 2023
Строка 1:		Строка 1:
			'''''[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0 Установка и настройка] / [https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы Ключ-Астром] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ Managed] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API REST API] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1 API Кластера v1] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1#SSL-.D1.81.D0.B5.D1.80.D1.82.D0.B8.D1.84.D0.B8.D0.BA.D0.B0.D1.82.D1.8B SSL-сертификаты] / Хранение SSL-сертификата кластера'''''

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

RGolovanov: Новая страница: «Этот вызов API сохраняет SSL-сертификат кластера. ==Аутентификация== Для выполнения этого за...»

2022-09-16T16:59:34Z

Новая страница: «Этот вызов API сохраняет 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 Аутентификация кластера].
==Конечная точка==
<code>/api/v1.0/onpremise/sslCertificate/store</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|entityType
|string
|тип объекта (<code>COLLECTOR</code>, <code>SERVER</code>)
|path
|Да
|-
|entityId
|integer
|Идентификатор узла, который можно извлечь из URL-адреса в представлении «Сведения об узле».
|path
|Да
|-
|body
|sslCertDto
|Конфигурация SSL-сертификата.
|body
|Нет
|}

=== Объекты тела запроса ===

==== Объект <code>sslCertDto</code> ====
Настройка SSL-сертификата.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|privateKeyEncoded
|string
|Стандарт закрытого ключа PKCS #8, формат PEM с кодировкой base64
|Да
|-
|publicKeyCertificateEncoded
|string
|Сертификат стандарта X.509, формат PEM с кодировкой base64, сертификат сервера
|Да
|-
|certificateChainEncoded
|string
|Сертификат(ы) Стандарт X.509, формат PEM с кодировкой base64, промежуточные и корневые сертификаты
|Нет
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"privateKeyEncoded": "-----BEGIN RSA PRIVATE KEY-----\nMIIEow...aHzMvp\n-----END RSA PRIVATE KEY-----",
"publicKeyCertificateEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----",
"certificateChainEncoded": "-----BEGIN CERTIFICATE-----\nMIIDKT...XbTK+M\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDKT...bXTK+M\n-----END CERTIFICATE-----"
}</code>

==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
|'''Тип'''
!Описание
|-
|'''200'''
|CertificateStoreStatus
|Успешно или в процессе
|-
|'''400'''
|CertificateStoreStatus
|Неверный тип объекта
|-
|'''404'''
|CertificateStoreStatus
|Статус не найден
|-
|'''500'''
|
|Внутренняя ошибка
|-
|'''522'''
|CertificateStoreStatus
|Цепочка сертификатов недействительна.
|-
|'''523'''
|CertificateStoreStatus
|Закрытый ключ не соответствует сертификату открытого ключа
|-
|'''525'''
|CertificateStoreStatus
|Сертификат открытого ключа недействителен
|-
|'''526'''
|CertificateStoreStatus
|Закрытый ключ недействителен
|-
|'''527'''
|CertificateStoreStatus
|Ошибка при сохранении SSL-сертификата
|-
|'''528'''
|CertificateStoreStatus
|Сертификат сохранен, но не обновлен
|-
|'''529'''
|CertificateStoreStatus
|Внутренняя ошибка
|}
===Объекты тела ответа===
====Объект <code>CertificateStoreStatus</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|certificateStoreStatus
|string
|Может иметь значения:
*<code>BAD_REQUEST</code>
*<code>CERTIFICATE_CHAIN_IS_INVALID</code>
*<code>CERTIFICATE_IS_EXPIRED</code>
*<code>CERTIFICATE_STORED_BUT_NOT_REFRESHED</code>
*<code>ERROR</code>
*<code>GENERAL_ERROR_WHILE_STORING_CERTIFICATE</code>
*<code>IN_PROGRESS</code>
*<code>NOT_FOUND</code>
*<code>OK</code>
*<code>PRIVATE_KEY_DOES_NOT_MATCH_PUBLIC_KEY_CERTIFICATE</code>
*<code>PRIVATE_KEY_IS_INVALID</code>
*<code>PUBLIC_KEY_CERTIFICATE_IS_INVALID</code>
|-
|detailedError
|string
| -
|}
===JSON-модель тела ответа===
<code>{
"certificateStoreStatus": "BAD_REQUEST",
"detailedError": "string"
}</code>
==Пример==
В этом примере вы храните сертификат SSL на ноде <code>№32</code> кластера <code>myManaged.cluster.com</code>. В ответ вы получаете информацию о том, что SSL-сертификат был успешно обновлен. Убедитесь, что ваш запрос в формате JSON. Это означает, что объекты <code>privateKeyEncoded</code>, <code>publicKeyCertificateEncoded</code> и <code>certificateChainEncoded</code> находятся в одной строке.
====Curl====
<code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki>" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"privateKeyEncoded\":\"-----BEGIN RSA PRIVATE KEY-----\MIIEow...aHzMvp\-----END RSA PRIVATE KEY-----\",\"publicKeyCertificateEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\",\"certificateChainEncoded\":\"-----BEGIN CERTIFICATE-----\MIIDKT...XbTK+M\-----END CERTIFICATE-----\-----BEGIN CERTIFICATE-----\MIIDKT...bXTK+M\-----END CERTIFICATE-----\"}"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32</nowiki></code>
====Тело ответа====
<code>Успешно обновлено. Ответ не имеет тела.</code>

====Код ответа====
<code>200</code>