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