POST отмены ротации: различия между версиями

Текущая версия от 17:32, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Токены v2 / Токены владельца / POST отмены ротации

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

Запрос создает в качестве полезной нагрузкиapplication/json формат.

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/cancel`
POST	Cреда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tenantTokenRotation/cancel`

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью ротации токенов владельца ( tenantTokenRotation.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

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

Ответ

Коды ответов

Код	Тип	Описание
200	TenantTokenConfig	Успех. Процесс ротации отменен. Текущий токен клиента остается действительным.
400	ErrorEnvelope	Не удалось. Постоянного процесса ротации нет.

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

Объект `TenantTokenConfig`

Конфигурация токена арендатора .

Элемент	Тип	Описание
old	TenantToken	Токен владельца
active	TenantToken	Токен владельца

Объект `TenantToken`

Токен арендатора

Элемент	Тип	Описание
value	string	Секрет токена владельца.

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

<{
  "old": {
    "value": "string"
  },
  "active": {}
}

Пример

В этом примере запрос отменяет процесс ротации, запущенный в примере запуска запроса .

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

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

Curl

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

Тело ответа

<{
  "active": {
    "value": "1234567890qrstuvwxyz"
  },
  "old": {
    "value": null
  }
}

Код ответа

200

@@ Строка 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 отмены ротации'''''
 Отменяет ротацию токена клиента . Новый токен отбрасывается, а старый остается действительным. Если вы настроили какие-либо ЕдиныеАгенты и АктивныеШлюзы для использования нового токена, вы должны восстановить старую конфигурацию.
@@ Строка 70: / Строка 72: @@
     },
     "active": {}
-  }</code>
+  }
 == Пример ==
@@ Строка 83: / Строка 85: @@
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/tenantTokenRotation/finish</nowiki> \
     -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-    -H 'Accept: application/json'</code>
+    -H 'Accept: application/json'
 ==== Тело ответа ====
@@ Строка 93: / Строка 95: @@
       "value": null
     }
-  }</code>
+  }
 ==== Код ответа ====