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

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

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

Получает метаданные токена АктивногоШлюза по его ID.

Запрос создает в качестве полезной нагрузкиapplication/json формат.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}`

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
activeGateTokenIdentifier	string	Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.	path	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	ActiveGateToken	Успех. Ответ содержит метаданные маркеров.
400	ErrorEnvelope	Не удалось. Ввод недействителен.
404	ErrorEnvelope	Не удалось. Запрошенный ресурс не существует.

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

Объект `ActiveGateToken`

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

Элемент	Тип	Описание
id	string	Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
name	string	Имя токена.
owner	string	Владелец токена.
creationDate	string	Дата создания токена в формате ISO 8601 ( `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
expirationDate	string	Дата истечения срока действия токена в формате ISO 8601 ( `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). Если не установлено, срок действия токена никогда не истекает.
lastUsedDate	string	Дата последнего использования токена в формате ISO 8601 ( `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
seedToken	boolean	Токен является начальным токеном ( `true`) или отдельным токеном ( `false`).
activeGateType	string	Тип АктивногоШлюза, для которого действителен токен. Элемент может содержать эти значения `ENVIRONMENT` `CLUSTER`

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

<{
  "id": "dt0g02.4KWZO5EF",
  "name": "myToken",
  "owner": "john.smith",
  "creationDate": "2020-11-22T08:15:30.144Z",
  "expirationDate": "2020-11-24T08:15:30.144Z",
  "lastUsedDate": "2020-11-23T08:15:30.144Z",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}

Пример

В этом примере запрос извлекает метаданные для маркера с идентификатором dt0g02.abc123 .

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

Curl

<curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123 \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

Тело ответа

<{
  "id": "dt0g02.abc123",
  "name": "system:installer",
  "owner": "max.mustermann@company.com",
  "creationDate": "2021-11-22T11:39:29.797Z",
  "seedToken": true,
  "activeGateType": "ENVIRONMENT"
}

Код ответа

200

@@ Строка 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 Токены АктивногоШлюза] / GET токен*'''''
 Получает метаданные токена АктивногоШлюза по его ID.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code>
 |-
@@ Строка 100: / Строка 102: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "id": "dt0g02.4KWZO5EF",
     "name": "myToken",
@@ Строка 109: / Строка 111: @@
     "seedToken": false,
     "activeGateType": "ENVIRONMENT"
-  }</code>
+  }
 == Пример ==
@@ Строка 117: / Строка 119: @@
 ==== Curl ====
-  <code>curl --request GET \
+  <curl --request GET \
     --url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens/dt0g02.abc123</nowiki> \
-    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 125: / Строка 127: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "id": "dt0g02.abc123",
     "name": "system:installer",
@@ Строка 132: / Строка 134: @@
     "seedToken": true,
     "activeGateType": "ENVIRONMENT"
-  }</code>
+  }
 ==== Код ответа ====