Просмотр кода страницы Получить информацию о конкретном АктивномШлюзе

Получает информацию об указанном АктивномШлюзе.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
|ПОЛУЧИТЬ
|
* Удалось https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId}
* SaaS https: // {ваша-среда-идентификатор} .live.dynatrace.com / api / v2 / activeGates / {agId}.
* Среда ActiveGate https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId}.
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение ActiveGates ( <code>activeGates.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!необходимые
|-
|стареть
|нить
|ID необходимого ActiveGate.
|дорожка
|обязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
!Описание
|-
|200
|Успех
|-
|404
|Не найден. См. Подробности в теле ответа.
|}

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

* Параметры ответа

==== ActiveGate объект ====
Параметры ActiveGate.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|я бы
|нить
|Идентификатор ActiveGate.
|-
|networkAddresses
|нить[]
|Список сетевых адресов ActiveGate.
|-
|loadBalancerAddresses
|нить[]
|Список адресов Load Balancer ActiveGate.
|-
|osType
|нить
|Тип ОС, на которой работает ActiveGate.

Элемент может содержать эти значения
|-
|autoUpdateStatus
|нить
|Текущий статус автообновлений ActiveGate.

Элемент может содержать эти значения
|-
|offline
|целое число
|Отметка времени, с которой ActiveGate отключен.

<code>null</code>Значение означает ActiveGate онлайн.
|-
|версия
|нить
|Текущая версия ActiveGate в <code><major>.<minor>.<revision>.<timestamp></code>формате.
|-
|тип
|нить
|Тип ActiveGate.

Элемент может содержать эти значения
|-
|имя хоста
|нить
|Имя хоста, на котором работает ActiveGate.
|-
|mainEnvironment
|нить
|Идентификатор основной среды для ActiveGate с несколькими средами.
|-
|окружающая среда
|нить[]
|Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.
|-
|autoUpdateSettings
|Активный Gate Auto Update Config
|
|-
|networkZone
|нить
|Сетевая зона ActiveGate.
|-
|группа
|нить
|Группа ActiveGate.
|-
|модули
|Активный Gate модуль []
|Список модулей ActiveGate.
|-
|контейнерный
|логический
|ActiveGate развертывается в контейнере ( <code>true</code>) или нет ( <code>false</code>).
|}

==== ActiveGateModule объект ====
Информация о модуле ActiveGate
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|неправильно настроен
|логический
|Модуль неправильно сконфигурирован ( <code>true</code>) или нет ( <code>false</code>).
|-
|тип
|нить
|Тип модуля ActiveGate.

Элемент может содержать эти значения
|-
|атрибуты
|объект
|Атрибуты модуля ActiveGate.
|-
|версия
|нить
|Версия модуля ActiveGate.
|-
|включено
|логический
|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
|}

==== ActiveGateAutoUpdateConfig объект ====
Настройка автообновлений ActiveGate.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|параметр
|нить
|Состояние автообновления ActiveGate: включено, отключено или унаследовано.

Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.

Элемент может содержать эти значения
|-
|EffectiveSetting
|нить
|Фактическое состояние автообновления ActiveGate.

Применимо, только если параметр настройки установлен на <code>INHERITED</code>. В этом случае значение берется из родительской настройки. В противном случае это просто дубликат значения настройки .

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

* Модель JSON

 <code>{
   "id": "0x3efdd091",
   "networkAddresses": [
     "string"
   ],
   "loadBalancerAddresses": [
     "string"
   ],
   "osType": "WINDOWS",
   "autoUpdateStatus": "OUTDATED",
   "offlineSince": 1582031917814,
   "version": "1.185.0.20200201-120000",
   "type": "ENVIRONMENT",
   "hostname": "exampleHostname",
   "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",
   "environments": [
     "string"
   ],
   "autoUpdateSettings": {
     "setting": "INHERITED",
     "effectiveSetting": "ENABLED"
   },
   "networkZone": "exampleNetworkZone",
   "group": "default",
   "modules": [
     {
       "misconfigured": true,
       "type": "KUBERNETES",
       "attributes": {},
       "version": "string",
       "enabled": true
     }
   ],
   "containerized": true
 }</code>

== Пример ==
В этом примере в запросе перечислены параметры ActiveGate с идентификатором 876651882 .

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

==== Curl ====
 <code>curl -L -X GET '<nowiki>https://mySampleEnv/api/v2/activeGates/876651882'</nowiki> \
 -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL запроса ====
 <code><nowiki>https://mySampleEnv/api/v2/activeGates/876651882</nowiki></code>

==== Тело ответа ====
 <code>{
   "id": "876651882",
   "networkAddresses": [
         "orange-13.easytravel.com",
         "228.245.125.39"
     ],
     "osType": "LINUX",
     "autoUpdateStatus": "UPDATE_IN_PROGRESS",
     "offlineSince": null,
     "version": "1.198.0.20200630-163221",
     "type": "ENVIRONMENT",
     "hostname": "orange-13.easytravel.com",
     "mainEnvironment": null,
     "environments": [
         "mySampleEnv"
     ],
     "networkZone": "easytravel.europe.austria.05"
 }</code>

==== Код ответа ====
200