Просмотр кода страницы Получение метаданных токена по запросу

Этот вызов API перечисляет метаданные токена кластера по значению токена. Запрос потребляет и создает полезную нагрузку <code>application/json</code>.

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

== Конечная точка ==
<code>/api/cluster/v2/tokens/lookup</code>

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|body
|Token
|Тело JSON запроса. Содержит требуемый токен.
|body
|Да
|}

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

==== Объект <code>Token</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|token
|string
|Токен аутентификации API.
|Да
|}

=== JSON-модель тела запроса ===
 <code>{
   "token": "abcdefjhij1234567890"
 }</code>

== Ответ ==

=== Коды ответа ===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|TokenMetadata
|Успех
|}

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

==== Объект <code>TokenMetadata</code> ====
{| class="wikitable"
!Element
!Type
!Description
|-
|id
|string
|Идентификатор токена.
|-
|name
|string
|Имя токена.
|-
|userId
|string
|Владелец токена.
|-
|revoked
|boolean
|Статус отзыва токена. Отозванные токены отключены.
|-
|created
|integer
|Время создания в виде временной метки unix в миллисекундах.
|-
|expires
|integer
|Время истечения срока действия в виде временной метки unix в миллисекундах.
|-
|lastUse
|integer
|Отметка времени unix в миллисекундах, когда токен использовался в последний раз.
|-
|scopes
|string[]
|Список областей, назначенных маркеру.

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

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

=== JSON-модель тела ответа ===
 <code>{
   "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"
   ]
 }</code>

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

==== Curl ====
<code>curl -X POST "<nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/lookup</nowiki>" -H  "accept: application/json; charset=utf-8" -H  "Content-Type: application/json; charset=utf-8" -d  "{  \"token\": \"abcdefjhij1234567890\"}"</code>

==== URL-адрес запроса ====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/lookup</nowiki></code>

==== Тело ответа ====
 <code>{
   "id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",
   "name": "myToken",
   "userId": "john.smith",
   "revoked": true,
   "created": 1554076800000,
   "expires": 1585976400000,
   "lastUse": 1554354000000,
   "scopes": [
     "DataExport",
     "ReadConfig",
     "WriteConfig"
   ]
 }</code>

==== Код ответа ====
<code>200</code>