GET токен*: различия между версиями
Материал из Dynatrace
ENetrebin (обсуждение | вклад) (Новая страница: «Получает метаданные токена АктивногоШлюза по его ID. Запрос создает в качестве полезной...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
Получает метаданные токена | Получает метаданные токена ActiveGate по его ID. | ||
Запрос создает в качестве полезной нагрузки<code>application/json</code> формат. | Запрос создает в качестве полезной нагрузки<code>application/json</code> формат. | ||
| Строка 7: | Строка 7: | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code> | ||
|- | |- | ||
|Среда | |Среда ActiveGate | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения токенов | Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения токенов ActiveGate ( <code>activeGateTokenManagement.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
| Строка 24: | Строка 24: | ||
|activeGateTokenIdentifier | |activeGateTokenIdentifier | ||
|string | |string | ||
|Идентификатор токена | |Идентификатор токена ActiveGate , состоящий из префикса и общедоступной части токена. | ||
|path | |path | ||
|требуется | |требуется | ||
| Строка 53: | Строка 53: | ||
==== Объект <code>ActiveGateToken</code> ==== | ==== Объект <code>ActiveGateToken</code> ==== | ||
Метаданные токена | Метаданные токена ActiveGate . | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 61: | Строка 61: | ||
|id | |id | ||
|string | |string | ||
|Идентификатор токена | |Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена. | ||
|- | |- | ||
|name | |name | ||
| Строка 91: | Строка 91: | ||
|activeGateType | |activeGateType | ||
|string | |string | ||
|Тип | |Тип ActiveGate, для которого действителен токен. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| Строка 118: | Строка 118: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl --request GET \ | <code>curl --request GET \ | ||
--url <nowiki>https://mySampleEnv.live. | --url <nowiki>https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens/dt0g02.abc123</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens/dt0g02.abc123</nowiki></code> | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
Текущая версия на 17:02, 13 февраля 2023
Получает метаданные токена ActiveGate по его ID.
Запрос создает в качестве полезной нагрузкиapplication/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}
|
| Среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens/{activeGateTokenIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения токенов ActiveGate ( activeGateTokenManagement.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| activeGateTokenIdentifier | string | Идентификатор токена ActiveGate , состоящий из префикса и общедоступной части токена. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ActiveGateToken | Успех. Ответ содержит метаданные маркеров. |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ActiveGateToken
Метаданные токена ActiveGate .
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена. |
| 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 | Тип ActiveGate, для которого действителен токен.
Элемент может содержать эти значения
|
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.dynatrace.com//api/v2/activeGateTokens/dt0g02.abc123 \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com//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
