Создание токена владельца среды
Этот вызов API создает новый токен управления окружением.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (EnvironmentTokenManagement)
, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/environments
Параметры
Параметр | Тип | Описание | В | Обязательно |
---|---|---|---|---|
id | string | Идентификатор среды, в которой токен действителен. | path | Да |
body | CreateEnvironmentTokenManagementToken | Тело JSON запроса. Содержит параметры токена. | body | Нет |
Объекты тела запроса
Объект CreateEnvironmentTokenManagementToken
Элемент | Тип | Описание | Обязательно |
---|---|---|---|
name | string | Имя токена. | Да |
expiresIn | Duration | Определяет период времени жизни токена. | Нет |
Объект Duration
Элемент | Тип | Описание | Обязательно |
---|---|---|---|
value | integer | Количество времени. | required |
unit | string | Единица времени.
Если не установлено, используется миллисекунда. Элемент может содержать эти значения:
|
optional |
JSON-модель тела запроса
{
"name": "Token Management",
"expiresIn": {
"value": 3600,
"unit": "SECONDS"
}
}
Ответ
Коды ответа
Элемент | Тип | Описание |
---|---|---|
201 | Token | Успех. Токен создан. Тело ответа содержит сам токен |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект Token
Краткое представление окружения.
Элемент | Тип | Описание |
---|---|---|
token | string | Токен аутентификации API Ключ-Астром. |
JSON-модель тела ответа
{
"token": "abcdefjhij1234567890"
}
Пример
Создает новый токен управления для среды 19a963a7-b19f-4382-964a-4df674c8eb8e
.
Curl
curl -X POST "https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken" -H "accept: application/json; charset=utf-8" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890" -H "Content-Type: application/json; charset=utf-8" -d "{\"name\":\"Token Management\",\"expiresIn\":{\"value\":3600,\"unit\":\"SECONDS\"}}"
URL-адрес запроса
https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e/tokenManagementToken
Тело запроса
{
"name": "Token Management",
"expiresIn": {
"value": 3600,
"unit": "SECONDS"
}
}
Тело ответа
{
"token": "dt0c01.RVSDGWUQEVQFS4CWIZTKX5DV.<token-value>"
}
Код ответа
201