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

Материал из Dynatrace
(Новая страница: «Список всех токенов АктивногоШлюза, доступных для вашей среды. Вы можете ограничить выв...»)
 
 
Строка 1: Строка 1:
Список всех токенов АктивногоШлюза, доступных для вашей среды.
Список всех токенов ActiveGate, доступных для вашей среды.


Вы можете ограничить вывод, используя нумерацию страниц:
Вы можете ограничить вывод, используя нумерацию страниц:
Строка 12: Строка 12:
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|-
|-
|Среда АктивногоШлюза
|Среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|}
|}
Строка 72: Строка 72:


==== Объект <code>ActiveGateTokenList</code> ====
==== Объект <code>ActiveGateTokenList</code> ====
Список токенов АктивногоШлюза.
Список токенов ActiveGate.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 94: Строка 94:
|activeGateTokens
|activeGateTokens
|ActiveGateToken[]
|ActiveGateToken[]
|Список токенов АктивногоШлюза.
|Список токенов ActiveGate.
|}
|}


==== Объект <code>ActiveGateToken</code> ====
==== Объект <code>ActiveGateToken</code> ====
Метаданные токена АктивногоШлюза.
Метаданные токена ActiveGate.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 106: Строка 106:
|id
|id
|string
|string
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена.
|-
|-
|name
|name
Строка 162: Строка 162:


== Пример ==
== Пример ==
В этом примере в запросе перечислены все токены АктивногоШлюза, доступные для среды mySampleEnv .
В этом примере в запросе перечислены все токены ActiveGate, доступные для среды mySampleEnv .


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


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens</nowiki></code>


==== Тело ответа ====
==== Тело ответа ====

Текущая версия на 17:00, 13 февраля 2023

Список всех токенов ActiveGate, доступных для вашей среды.

Вы можете ограничить вывод, используя нумерацию страниц:

  1. Укажите количество результатов на странице в параметре запроса pageSize .
  2. Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens
Среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens

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

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

Параметры

Параметр Тип Описание In Необходимость
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

query по желанию
pageSize integer Количество токенов АктивногоШлюза в полезной нагрузке одного ответа.

Максимально допустимый размер страницы — 3000, а минимальный — 100.

Если не установлено, используется 100.

query по желанию

Ответ

Коды ответов

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

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

Объект ActiveGateTokenList

Список токенов ActiveGate.

Элемент Тип Описание
totalCount integer Общее количество записей в результате.
pageSize integer Количество записей на странице.
nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

activeGateTokens ActiveGateToken[] Список токенов ActiveGate.

Объект 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 Тип АктивногоШлюза, для которого действителен токен.

Элемент может содержать эти значения

  • ENVIRONMENT
  • CLUSTER

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

{
  "totalCount": 1000,
  "pageSize": 100,
  "nextPageKey": "AAAAAAAAAAAAAABOAAAAAAAAAAAAAAA6ACQAEAAAABgACgAITFdXQk1BRzYAAAhtZXRhZGF0YQB___-bf___m3iIYxfF7xVQvY72rwblQkcAAwAAAAAAAADHAAAAZA==",
  "activeGateTokens": {
    "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"
  }
}

Пример

В этом примере в запросе перечислены все токены ActiveGate, доступные для среды mySampleEnv .

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

Результат усекается до трех записей.

Curl

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

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

https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens

Тело ответа

{
  "totalCount": 3,
  "pageSize": 3,
  "activeGateTokens": [
    {
      "id": "dt0g02.abc123",
      "name": "system:installer",
      "owner": "max.mustermann@company.com",
      "creationDate": "2021-11-22T11:39:29.797Z",
      "seedToken": true,
      "activeGateType": "ENVIRONMENT"
    },
    {
      "id": "dt0g02.321cba",
      "name": "system:installer",
      "owner": "john.smith@company.com",
      "creationDate": "2021-11-30T14:11:40.913Z",
      "seedToken": true,
      "activeGateType": "ENVIRONMENT"
    },
    {
      "id": "dt0g02.123abc",
      "name": "system:initial-setup",
      "owner": "mary.brown@company.com",
      "creationDate": "2021-10-22T13:48:00.135Z",
      "lastUsedDate": "2021-12-02T11:52:17.201Z",
      "seedToken": false,
      "activeGateType": "ENVIRONMENT"
    },
  ]
}

Код ответа

200