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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает информацию об указанном ActiveGate. Запрос создает <code>application/json</code>полезную нагруз...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
Получает информацию об указанном ActiveGate.
Получает информацию об указанном АктивномШлюзе.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Строка 7: Строка 7:
* Удалось https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId}
* Удалось https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId}
* SaaS https: // {ваша-среда-идентификатор} .live.dynatrace.com / 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}.
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId}.
|}
|}


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


== Параметры ==
== Параметры ==
Строка 23: Строка 23:
|стареть
|стареть
|нить
|нить
|ID необходимого ActiveGate.
|ID необходимого АктивногоШлюза.
|дорожка
|дорожка
|обязательный
|обязательный
Строка 46: Строка 46:
* Параметры ответа
* Параметры ответа


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


Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 73: Строка 73:
|autoUpdateStatus
|autoUpdateStatus
|нить
|нить
|Текущий статус автообновлений ActiveGate.
|Текущий статус автообновлений АктивногоШлюза.


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


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


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


==== ActiveGateModule объект ====
==== Модуль АктивногоШлюза ====
Информация о модуле ActiveGate
Информация о модуле АктивногоШлюза
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 139: Строка 139:
|тип
|тип
|нить
|нить
|Тип модуля ActiveGate.
|Тип модуля АктивногоШлюза.


Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 145: Строка 145:
|атрибуты
|атрибуты
|объект
|объект
|Атрибуты модуля ActiveGate.
|Атрибуты модуля АктивногоШлюза.
|-
|-
|версия
|версия
|нить
|нить
|Версия модуля ActiveGate.
|Версия модуля АктивногоШлюза.
|-
|-
|включено
|включено
Строка 157: Строка 157:


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


Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.
Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.
Строка 173: Строка 173:
|EffectiveSetting
|EffectiveSetting
|нить
|нить
|Фактическое состояние автообновления ActiveGate.
|Фактическое состояние автообновления АктивногоШлюза.


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


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


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


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

Текущая версия на 16:12, 21 сентября 2023

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

Запрос создает application/jsonполезную нагрузку.

ПОЛУЧИТЬ
  • Удалось https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId}
  • SaaS https: // {ваша-среда-идентификатор} .live.dynatrace.com / api / v2 / activeGates / {agId}.
  • Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId}.

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

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

Параметры

Параметр Тип Описание В необходимые
стареть нить ID необходимого АктивногоШлюза. дорожка обязательный

Ответ

Коды ответов

Код Описание
200 Успех
404 Не найден. См. Подробности в теле ответа.

Тело ответа

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

АктивныйШлюз объект

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

Элемент Тип Описание
я бы нить Идентификатор АктивногоШлюза.
networkAddresses нить[] Список сетевых адресов АктивногоШлюза.
loadBalancerAddresses нить[] Список адресов Load Balancer АктивногоШлюза.
osType нить Тип ОС, на которой работает АктивныйШлюз.

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

autoUpdateStatus нить Текущий статус автообновлений АктивногоШлюза.

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

offline целое число Отметка времени, с которой АктивныйШлюз отключен.

nullЗначение означает АктивныйШлюз онлайн.

версия нить Текущая версия АктивногоШлюза в <major>.<minor>.<revision>.<timestamp>формате.
тип нить Тип АктивногоШлюза.

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

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

Модуль АктивногоШлюза

Информация о модуле АктивногоШлюза

Элемент Тип Описание
неправильно настроен логический Модуль неправильно сконфигурирован ( true) или нет ( false).
тип нить Тип модуля АктивногоШлюза.

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

атрибуты объект Атрибуты модуля АктивногоШлюза.
версия нить Версия модуля АктивногоШлюза.
включено логический Модуль включен ( true) или отключен ( false).

ActiveGateAutoUpdateConfig объект

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

Элемент Тип Описание
параметр нить Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.

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

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

EffectiveSetting нить Фактическое состояние автообновления АктивногоШлюза.

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

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

  • Модель JSON
{
  "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
}

Пример

В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 876651882 .

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

Curl

curl -L -X GET 'https://mySampleEnv/api/v2/activeGates/876651882' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

https://mySampleEnv/api/v2/activeGates/876651882

Тело ответа

{
  "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"
}

Код ответа

200