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

2025-01-06T16:59:31Z

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

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

Строка 104:		Строка 106:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"id": "acbed0c4-4ef1-4303-991f-102510a69322",		"id": "acbed0c4-4ef1-4303-991f-102510a69322",
	"name": "myToken",		"name": "myToken",
Строка 130:		Строка 132:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",		"id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",
	"name": "myToken",		"name": "myToken",

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

2022-09-22T14:08:28Z

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

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

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

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|id
|string
|Идентификатор требуемого токена.
|path
|Да
|}

== Ответ ==

=== Коды ответа ===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|TokenMetadata
|Успех
|-
|'''404'''
|ErrorEnvelope
|Не удалось. Запрошенный токен не найден.
|}

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

==== Объект <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>

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

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

==== URL-адрес запроса ====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4</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>204</code>

Получение метаданных токена по ID - История изменений

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

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