POST окончания ротации - История изменений

IKuznetsov в 17:31, 2 января 2025

2025-01-02T17:31:36Z

← Предыдущая версия		Версия от 17:31, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=PUT%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2,-%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0 Токены v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%BE%D0%BA%D0%B5%D0%BD-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B2%D0%BB%D0%B0%D0%B4%D0%B5%D0%BB%D1%8C%D1%86%D0%B0,-POST%20%D1%81%D1%82%D0%B0%D1%80%D1%82%20%D1%80%D0%BE%D1%82%D0%B0%D1%86%D0%B8%D0%B8 Токены владельца] / POST окончания ротации'''''

	Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняйте запрос только после обновления всех ЕдиныхАгентов и АктивныхШлюзов, как описано в разделе « Ротация токена владельца » .		Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняйте запрос только после обновления всех ЕдиныхАгентов и АктивныхШлюзов, как описано в разделе « Ротация токена владельца » .

Строка 72:		Строка 74:
	},		},
	"active": {}		"active": {}
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 85:		Строка 87:
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Accept: application/json'~~</code>~~		-H 'Accept: application/json'

	==== Тело ответа ====		==== Тело ответа ====
Строка 95:		Строка 97:
	"value": "1234567890qrstuvwxyz"		"value": "1234567890qrstuvwxyz"
	}		}
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	200		200

IKuznetsov в 20:50, 25 декабря 2024

2024-12-25T20:50:32Z

← Предыдущая версия		Версия от 20:50, 25 декабря 2024
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish</nowiki></code>
	\|-		\|-
Строка 67:		Строка 67:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"old": {		"old": {
	"value": "string"		"value": "string"
Строка 82:		Строка 82:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X POST \		<curl -X POST \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 88:		Строка 88:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"active": {		"active": {
	"value": "zyxwvutsrq0987654321"		"value": "zyxwvutsrq0987654321"

ENetrebin в 14:47, 25 октября 2022

2022-10-25T14:47:26Z

← Предыдущая версия		Версия от 14:47, 25 октября 2022
Строка 3:		Строка 3:
	Во избежание потери данных в процессе ротации действуют как старые, так и новые токены. Во время ротации не развертывайте никаких новых ЕдиныхАгентов, пока все ваши АктивныхШлюзов не будут настроены с использованием нового токена владельца.		Во избежание потери данных в процессе ротации действуют как старые, так и новые токены. Во время ротации не развертывайте никаких новых ЕдиныхАгентов, пока все ваши АктивныхШлюзов не будут настроены с использованием нового токена владельца.

	Запрос создает <code>application/json</code>~~полезную нагрузку~~.		Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST

ENetrebin: Новая страница: «Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняй...»

2022-10-25T14:46:09Z

Новая страница: «Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняй...»

Новая страница

Завершает ротацию токена владельца. Старый токен становится недействительным. Выполняйте запрос только после обновления всех ЕдиныхАгентов и АктивныхШлюзов, как описано в разделе « Ротация токена владельца » .

Во избежание потери данных в процессе ротации действуют как старые, так и новые токены. Во время ротации не развертывайте никаких новых ЕдиныхАгентов, пока все ваши АктивныхШлюзов не будут настроены с использованием нового токена владельца.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/finish</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью ротации токенов владельца ( <code>tenantTokenRotation.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
Запрос не предоставляет никаких настраиваемых параметров.

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|TenantTokenConfig
|Успех. Процесс вращения завершен. Активное поле ответа содержит новый токен арендатора.
|-
|400
|ErrorEnvelope
|Нет постоянного процесса ротации.
|}

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

==== Объект <code>TenantTokenConfig</code> ====
Конфигурация токена арендатора .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|old
|TenantToken
|Токен владельца
|-
|active
|TenantToken
|Токен владельца
|}

==== Объект <code>TenantToken</code> ====
Токен арендатора
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|value
|string
|Секрет токена арендатора.
|}

=== JSON-модель тела ответа ===
<code>{
"old": {
"value": "string"
},
"active": {}
}</code>

== Пример ==
В этом примере запрос завершает процесс ротации, начатый в примере запуска запроса .

Код ответа 200 указывает на успешный запрос. Старый токен 1234567890qrstuvwxyz больше недействителен.

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: application/json'</code>

==== Тело ответа ====
<code>{
"active": {
"value": "zyxwvutsrq0987654321"
},
"old": {
"value": "1234567890qrstuvwxyz"
}
}</code>

==== Код ответа ====
200