Получение метаданных токена по ID

Материал из Документация Ключ-АСТРОМ
Версия от 14:08, 22 сентября 2022; RGolovanov (обсуждение | вклад) (Новая страница: «Этот вызов API перечисляет метаданные токена кластера по идентификатору токена. == Аутент...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API перечисляет метаданные токена кластера по идентификатору токена.

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

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

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

/api/cluster/v2/tokens

Параметры

Параметр Тип Описание В Обязательно
id string Идентификатор требуемого токена. path Да

Ответ

Коды ответа

Код Тип Описание
200 TokenMetadata Успех
404 ErrorEnvelope Не удалось. Запрошенный токен не найден.

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

Объект TokenMetadata

Element Type Description
id string Идентификатор токена.
name string Имя токена.
userId string Владелец токена.
revoked boolean Статус отзыва токена. Отозванные токены отключены.
created integer Время создания в виде временной метки unix в миллисекундах.
expires integer Время истечения срока действия в виде временной метки unix в миллисекундах.
lastUse integer Отметка времени unix в миллисекундах, когда токен использовался в последний раз.
scopes string[] Список областей, назначенных маркеру.

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

  • ClusterTokenManagement
  • ControlManagement
  • DiagnosticExport
  • EnvironmentTokenManagement
  • ExternalSyntheticIntegration
  • Nodekeeper
  • ReadSyntheticData
  • ServiceProviderAPI
  • UnattendedInstall
  • activeGateTokenManagement.create
  • activeGateTokenManagement.read
  • activeGateTokenManagement.write
  • apiTokens.read
  • apiTokens.write
  • settings.read
  • settings.write
personalAccessToken boolean Токен является токеном личного доступа (true) или токен API (false).

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

{
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "personalAccessToken": true,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Пример

В этом примере запрос получает метаданные токена с идентификатором 4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4" -H  "accept: application/json; charset=utf-8"

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

https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4

Тело ответа

{
  "id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Код ответа

204

Источник — https://doc.ruscomtech.ru/index.php?title=Получение_метаданных_токена_по_ID&oldid=1334