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

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

2025-01-06T16:57:20Z

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

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

Строка 133:		Строка 135:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Astrom-Key~~ entity 1",		"name": "AppOptima entity 1",
	"description": "~~Astrom-Key~~ entity 1 for the REST API example"		"description": "AppOptima entity 1 for the REST API example"
	},		},
	{		{
	"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",		"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
	"name": "~~Astrom-Key~~ entity 2"		"name": "AppOptima entity 2"
	},		},
	{		{
Строка 144:		Строка 146:
	}		}
	]		]
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере в запросе перечислены токены API в среде <code>myManaged.cluster.com</code> для пользователя <code>Pete</code> с разрешениями на управление токенами кластера.		В этом примере в запросе перечислены токены API в среде <code>myManaged.cluster.com</code> для пользователя <code>Pete</code> с разрешениями на управление токенами кластера.
Строка 157:		Строка 159:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Astrom-Key~~ entity 1",		"name": "AppOptima entity 1",
	"description": "~~Astrom-Key~~ entity 1 for the REST API example"		"description": "AppOptima entity 1 for the REST API example"
	},		},
	{		{
	"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",		"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
	"name": "~~Astrom-Key~~ entity 2"		"name": "AppOptima entity 2"
	},		},
	{		{
Строка 168:		Строка 170:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>200</code>		<code>200</code>

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

2024-11-08T13:29:09Z

← Предыдущая версия		Версия от 13:29, 8 ноября 2024
Строка 8:		Строка 8:

	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение 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~~ Аутентификация кластера].		Для выполнения этого запроса вам необходимо разрешение API <code>(ClusterTokenManagement)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
	==Конечная точка==		==Конечная точка==
	<code>/api/cluster/v2/tokens</code>		<code>/api/cluster/v2/tokens</code>
Строка 96:		Строка 96:
	\|values		\|values
	\|EntityShortRepresentation[]		\|EntityShortRepresentation[]
	\|Упорядоченный список кратких представлений объектов ~~Ключ-Астром~~.		\|Упорядоченный список кратких представлений объектов АппОптима.
	\|-		\|-
	\|name		\|name
Строка 129:		Строка 129:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"values": [		"values": [
	{		{
Строка 153:		Строка 153:

	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"values": [		"values": [
	{		{

RGolovanov в 17:57, 22 сентября 2022

2022-09-22T17:57:00Z

← Предыдущая версия		Версия от 17:57, 22 сентября 2022
Строка 133:		Строка 133:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Dynatrace~~ entity 1",		"name": "Astrom-Key entity 1",
	"description": "~~Dynatrace~~ entity 1 for the REST API example"		"description": "Astrom-Key entity 1 for the REST API example"
	},		},
	{		{
	"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",		"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
	"name": "~~Dynatrace~~ entity 2"		"name": "Astrom-Key entity 2"
	},		},
	{		{
Строка 157:		Строка 157:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Dynatrace~~ entity 1",		"name": "Astrom-Key entity 1",
	"description": "~~Dynatrace~~ entity 1 for the REST API example"		"description": "Astrom-Key entity 1 for the REST API example"
	},		},
	{		{
	"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",		"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
	"name": "~~Dynatrace~~ entity 2"		"name": "Astrom-Key entity 2"
	},		},
	{		{

RGolovanov в 15:03, 22 сентября 2022

2022-09-22T15:03:45Z

← Предыдущая версия		Версия от 15:03, 22 сентября 2022
Строка 1:		Строка 1:
	Этот вызов API перечисляет доступные ~~маркеры~~ в вашей среде.		Этот вызов API перечисляет доступные токены в вашей среде.

	Вы можете сузить вывод, добавив параметры. Токен должен соответствовать всем указанным параметрам.		Вы можете сузить вывод, добавив параметры. Токен должен соответствовать всем указанным параметрам.

RGolovanov: Новая страница: «Этот вызов API перечисляет доступные маркеры в вашей среде. Вы можете сузить вывод, добав...»

2022-09-22T13:43:03Z

Новая страница: «Этот вызов API перечисляет доступные маркеры в вашей среде. Вы можете сузить вывод, добав...»

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

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

Вы можете сузить вывод, добавив параметры. Токен должен соответствовать всем указанным параметрам.

Вы также можете указать лимит возвращаемых токенов.

Этот список может содержать токены, которые были созданы автоматически (например, InstallerDownload, Mobile, …) и не отображаются на странице настроек. Их удаление может иметь непреднамеренные побочные эффекты, поскольку они все еще могут использоваться.

==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение 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>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|limit
|integer
|Ограничивает максимальное количество возвращаемых токенов.

Если не установлено, используется значение <code>1000</code>.

Максимальное значение — <code>1000000</code>.
|query
|Нет
|-
|user
|string
|Фильтрует результирующий набор токенов по пользователю, которому принадлежит токен.
|query
|Нет
|-
|permissions
|string[]
|Фильтрует результирующий набор токенов по областям, назначенным токену.

Вы можете указать несколько разрешений в следующем формате: <code>permissions=scope1&permissions=scope2</code>.

Токен должен иметь ''все'' указанные области.

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

* <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>
|query
|Нет
|-
|from
|integer
|Последнее использование после этой метки времени (миллисекунды UTC).
|query
|Нет
|-
|to
|integer
|Последнее использование перед этой отметкой времени (миллисекунды UTC).
|query
|Нет
|}
==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|StubList
|Успешно
|}
===Объекты тела ответа===
====Объект <code>StubList</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|values
|EntityShortRepresentation[]
|Упорядоченный список кратких представлений объектов Ключ-Астром.
|-
|name
|string
|Имя объекта.
|-
|description
|string
|Краткое описание сущности.
|-
|tokenManagementToken
|string
|Токен с разрешением «Управление токенами». Может использоваться во вновь созданной среде для создания других токенов для настройки этой среды. Это значение задается только в том случае, если среда была создана с параметром запроса createToken=true.
|}
====Объект <code>EntityShortRepresentation</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор объекта.
|-
|name
|string
|Имя объекта.
|-
|description
|string
|Краткое описание объекта.
|}
===JSON-модель тела ответа===
<code>{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}</code>
==Пример==
В этом примере в запросе перечислены токены API в среде <code>myManaged.cluster.com</code> для пользователя <code>Pete</code> с разрешениями на управление токенами кластера.
====Curl====
<code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens?limit=1000&user=Pete&permissions=ClusterTokenManagement</nowiki>" -H "accept: application/json; charset=utf-8"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/tokens?limit=1000</nowiki></code>

====Тело ответа====
<code>{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}</code>
====Код ответа====
<code>200</code>