Создание токена владельца среды - История изменений

IKuznetsov в 16:53, 6 января 2025

2025-01-06T16:53:04Z

← Предыдущая версия		Версия от 16:53, 6 января 2025
Строка 1:		Строка 1:
			'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима\|REST API]] / [[API Кластера v2]] / [[API Кластера v2\|Окружения]] / Создание токена владельца среды'''''

	Этот вызов API создает новый токен управления окружением.		Этот вызов API создает новый токен управления окружением.
	==Аутентификация==		==Аутентификация==
Строка 76:		Строка 78:
	"unit": "SECONDS"		"unit": "SECONDS"
	}		}
	}~~</code>~~		}
	==Ответ==		==Ответ==
	===Коды ответа===		===Коды ответа===
Строка 107:		Строка 109:
	<{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}~~</code>~~		}
	==Пример==		==Пример==
	Создает новый токен управления для среды <code>19a963a7-b19f-4382-964a-4df674c8eb8e</code>.		Создает новый токен управления для среды <code>19a963a7-b19f-4382-964a-4df674c8eb8e</code>.
Строка 121:		Строка 123:
	"unit": "SECONDS"		"unit": "SECONDS"
	}		}
	}~~</code>~~		}

	==== Тело ответа ====		==== Тело ответа ====
	<{		<{
	"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"		"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>201</code>		<code>201</code>

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

2024-11-08T13:28:57Z

← Предыдущая версия		Версия от 13:28, 8 ноября 2024
Строка 1:		Строка 1:
	Этот вызов API создает новый токен управления окружением.		Этот вызов API создает новый токен управления окружением.
	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение API <code>(EnvironmentTokenManagement)</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>(EnvironmentTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
	==Конечная точка==		==Конечная точка==
	<code>/api/cluster/v2/environments</code>		<code>/api/cluster/v2/environments</code>
Строка 70:		Строка 70:
	\|}		\|}
	====JSON-модель тела запроса====		====JSON-модель тела запроса====
	<~~code>~~{		<{
	"name": "Token Management",		"name": "Token Management",
	"expiresIn": {		"expiresIn": {
Строка 102:		Строка 102:
	\|token		\|token
	\|string		\|string
	\|Токен аутентификации API ~~Ключ-Астром~~.		\|Токен аутентификации API АппОптима.
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"token": "abcdefjhij1234567890"		"token": "abcdefjhij1234567890"
	}</code>		}</code>
Строка 115:		Строка 115:
	<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken</nowiki></code>		<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"name": "Token Management",		"name": "Token Management",
	"expiresIn": {		"expiresIn": {
Строка 124:		Строка 124:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"		"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"
	}</code>		}</code>
	====Код ответа====		====Код ответа====
	<code>201</code>		<code>201</code>

RGolovanov: Новая страница: «Этот вызов API создает новый токен управления окружением. ==Аутентификация== Для выполнени...»

2022-09-22T13:36:27Z

Новая страница: «Этот вызов API создает новый токен управления окружением. ==Аутентификация== Для выполнени...»

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

Этот вызов API создает новый токен управления окружением.
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение API <code>(EnvironmentTokenManagement)</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/cluster/v2/environments</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|id
|string
|Идентификатор среды, в которой токен действителен.
|path
|Да
|-
|body
|CreateEnvironmentTokenManagementToken
|Тело JSON запроса. Содержит параметры токена.
|body
|Нет
|}
===Объекты тела запроса===
====Объект <code>CreateEnvironmentTokenManagementToken</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|name
|string
|Имя токена.
|Да
|-
|expiresIn
|Duration
|Определяет период времени жизни токена.
|Нет
|}
====Объект <code>Duration</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|value
|integer
|Количество времени.
|required
|-
|unit
|string
|Единица времени.

Если не установлено, используется миллисекунда.

Элемент может содержать эти значения:

* <code>DAYS</code>
* <code>HOURS</code>
* <code>MILLIS</code>
* <code>MINUTES</code>
* <code>SECONDS</code>
|optional
|}
====JSON-модель тела запроса====
<code>{
"name": "Token Management",
"expiresIn": {
"value": 3600,
"unit": "SECONDS"
}
}</code>
==Ответ==
===Коды ответа===
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|'''201'''
|Token
|Успех. Токен создан. Тело ответа содержит сам токен
|-
|'''400'''
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}
===Объекты тела ответа===
====Объект <code>Token</code>====
Краткое представление окружения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|token
|string
|Токен аутентификации API Ключ-Астром.
|}
===JSON-модель тела ответа===
<code>{
"token": "abcdefjhij1234567890"
}</code>
==Пример==
Создает новый токен управления для среды <code>19a963a7-b19f-4382-964a-4df674c8eb8e</code>.
====Curl====
<code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken</nowiki>" -H "accept: application/json; charset=utf-8" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890" -H "Content-Type: application/json; charset=utf-8" -d "{\"name\":\"Token Management\",\"expiresIn\":{\"value\":3600,\"unit\":\"SECONDS\"}}"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken</nowiki></code>
====Тело запроса====
<code>{
"name": "Token Management",
"expiresIn": {
"value": 3600,
"unit": "SECONDS"
}
}</code>

==== Тело ответа ====
<code>{
"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"
}</code>
====Код ответа====
<code>201</code>