Создание нового токена: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Этот вызов API создает новый токен кластера. ==Аутентификация== Для выполнения этого запро...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
Этот вызов API создает новый токен кластера.
Этот вызов API создает новый токен кластера.
==Аутентификация==
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение 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>(ClusterTokenManagement)</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/tokens</code>
<code>/api/cluster/v2/tokens</code>
Строка 19: Строка 19:
|}
|}
===Объекты тела запроса===
===Объекты тела запроса===
====Объект CreateToken====
====Объект <code>CreateToken</code>====
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент

Текущая версия на 13:57, 22 сентября 2022

Этот вызов API создает новый токен кластера.

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

Для выполнения этого запроса вам необходимо разрешение API (ClusterTokenManagement), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/tokens

Параметры

Параметр Тип Описание В Обязательно
body CreateToken Тело JSON запроса. Содержит параметры нового токена. body Да

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

Объект CreateToken

Элемент Тип Описание Обязательно
name string Имя токена. Да
expiresIn Duration Defines a period of time. Нет
scopes string[] Список областей, которые должны быть назначены токену.
  • DiagnosticExport: Диагностический Экспорт.
  • ControlManagement: КонтрольМенеджмента.
  • UnattendedInstall: Автоматическая установка.
  • ServiceProviderAPI: Service Provider API.
  • ExternalSyntheticIntegration: Создание и чтение синтетических мониторов, местоположений и узлов.
  • ClusterTokenManagement: Управление токенами кластера.
  • ReadSyntheticData: Чтение синтетических мониторов, местоположений и узлов.
  • Nodekeeper: Доступ к Nodekeeper для управления узлами.
  • EnvironmentTokenManagement: «Управление токенами» Создание токенов для существующих сред.
  • activeGateTokenManagement.read: Чтение токенов АктивногоШлюза.
  • activeGateTokenManagement.create: Создание токенов АктивногоШлюза.
  • activeGateTokenManagement.write: Запись токенов АктивногоШлюза.
  • settings.read: Чтение настроек.
  • settings.write: Записать настройки.
  • apiTokens.read: Чтение токенов API.
  • apiTokens.write: Написать токены API.
 Нет

Объект Duration

Элемент Тип Описание Обязательно
value integer Количество времени. Да
unit string Единица времени.

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

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

  • DAYS
  • HOURS
  • MILLIS
  • MINUTES
  • SECONDS
 Нет

JSON-модель тела запроса

{
  "name": "string",
  "expiresIn": {
    "value": 1,
    "unit": "DAYS"
  },
  "scopes": [
    "DiagnosticExport"
  ]
}

Ответ

Коды ответа

Код Тип Описание
201 Token Успех. Токен создан. Тело ответа содержит сам токен.
400 ErrorEnvelope Не удалось. Ввод недействителен. Тело ответа содержит подробные сведения.

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

Объект Token

Element Type Description
token string Токен аутентификации API.

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

{
  "token": "abcdefjhij1234567890"
}

Пример

В этом примере запрос создает новый токен с именем Mytoken, действительный в течение 24 часов. С помощью этого токена вы сможете выполнять диагностический экспорт (DiagnosticExport) и автоматическую установку (UnattendedInstall).

Curl

curl -X POST "https://myManaged.cluster.com/api/cluster/v2/tokens" -H "accept: application/json; charset=utf-8" -H "Content-Type: application/json; charset=utf-8" -d "{  \"name\": \"MyToken\",  \"scopes\": [    \"DiagnosticExport\",    \"UnattendedInstall\"  ],  \"expiresIn\": {    \"value\": 24,    \"unit\": \"HOURS\"  }}"

URL-адрес запроса

https://myManaged.cluster.com/api/cluster/v2/tokens

Тело запроса

{
  "name": "MyToken",
  "scopes": ["DiagnosticExport", "UnattendedInstall"],
  "expiresIn": {
    "value": 24,
    "unit": "HOURS"
  }
}

Тело ответа

{
  "token": "abcdefjhij1234567890"
}

Код ответа

201

Источник — https://doc.ruscomtech.ru/index.php?title=Создание_нового_токена&oldid=1330