POST токен*: различия между версиями

Текущая версия от 17:29, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Токены v2 / Токены АктивногоШлюза / POST токен*

Создает новый токен АктивногоШлюза.

Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова.

Запрос создает и использует application/json формат.

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens`
POST	Окружающая среда ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов АктивногоШлюза ( activeGateTokenManagement.create) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
body	ActiveGateTokenCreate	Тело JSON запроса. Содержит параметры нового токена АктивногоШлюза.	body	требуется

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

Объект `ActiveGateTokenCreate`

Параметры нового токена АктивногоШлюза.

Элемент	Тип	Описание	Необходимость
name	string	Имя токена.	требуется
expirationDate	string	Срок действия токена. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы Если не установлено, срок действия токена никогда не истекает.	по желанию
seedToken	boolean	Токен является начальным токеном ( `true`) или отдельным токеном ( `false`). Мы рекомендуем использовать индивидуальный токен (false).	по желанию
activeGateType	string	Тип АктивногоШлюза, для которого действителен токен. Элемент может содержать эти значения `ENVIRONMENT` `CLUSTER`	требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "name": "myToken",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}

Ответ

Коды ответов

Код	Тип	Описание
201	ActiveGateTokenCreated	Успех. Токен создан. Тело ответа содержит секрет токена.
400	ErrorEnvelope	Не удалось. Ввод недействителен.

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

Объект `ActiveGateTokenCreated`

Недавно созданный токен АктивногоШлюза.

Элемент	Тип	Описание
id	string	Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
token	string	Секрет токена.
expirationDate	string	Дата истечения срока действия токена в формате ISO 8601 ( `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).

JSON-модель тела ответа

<{
  "id": "dt0g02.4KWZO5EF",
  "token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
  "expirationDate": "2020-11-24T08:15:30.144Z"
}

Пример

В этом примере запрос создает новый токен АктивногоШлюза для среды АктивногоШлюза. Токен действителен в течение двух недель (14 дней) с момента создания.

Маркер API передается в заголовке авторизации .

Curl

<curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   --header 'Content-Type: application/json' \
  --data '{
  "name": "REST test",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens

Тело запроса

<{
  "name": "REST test",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}

Тело ответа

<{
  "id": "dt0g02.xyz789",
  "token": "dt0g02.xyz789.987654321zyxwvutsrq",
  "expirationDate": "2021-12-14T13:42:31.148Z"
}

Код ответа

201

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=PUT%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2,-%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0 Токены v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D0%BE%D0%B3%D0%BE%D0%A8%D0%BB%D1%8E%D0%B7%D0%B0 Токены АктивногоШлюза] / POST токен*'''''
 Создает новый токен АктивногоШлюза.
@@ Строка 90: / Строка 92: @@
     "seedToken": false,
     "activeGateType": "ENVIRONMENT"
-  }</code>
+  }
 == Ответ ==
@@ Строка 136: / Строка 138: @@
     "token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
     "expirationDate": "2020-11-24T08:15:30.144Z"
-  }</code>
+  }
 == Пример ==
@@ Строка 153: / Строка 155: @@
     "seedToken": false,
     "activeGateType": "ENVIRONMENT"
-  }'</code>
+  }'
 ==== URL-адрес запроса ====
@@ Строка 164: / Строка 166: @@
     "seedToken": false,
     "activeGateType": "ENVIRONMENT"
-  }</code>
+  }
 ==== Тело ответа ====
@@ Строка 171: / Строка 173: @@
     "token": "dt0g02.xyz789.987654321zyxwvutsrq",
     "expirationDate": "2021-12-14T13:42:31.148Z"
-  }</code>
+  }
 ==== Код ответа ====