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

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


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Строка 223: Строка 223:
Токен 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>

Версия 17:39, 6 октября 2022

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

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

ПОЛУЧИТЬ
  • Удалось 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 ( activeGates.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

Параметры

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

Ответ

Коды ответов

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

Тело ответа

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

ActiveGate объект

Параметры ActiveGate.

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

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

autoUpdateStatus нить Текущий статус автообновлений ActiveGate.

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

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

nullЗначение означает ActiveGate онлайн.

версия нить Текущая версия ActiveGate в <major>.<minor>.<revision>.<timestamp>формате.
тип нить Тип ActiveGate.

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

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

ActiveGateModule объект

Информация о модуле ActiveGate

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

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

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

ActiveGateAutoUpdateConfig объект

Настройка автообновлений ActiveGate.

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

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

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

EffectiveSetting нить Фактическое состояние автообновления ActiveGate.

Применимо, только если параметр настройки установлен на 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
}

Пример

В этом примере в запросе перечислены параметры ActiveGate с идентификатором 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

Источник — https://doc.ruscomtech.ru/index.php?title=Получить_информацию_о_конкретном_АктивномШлюзе&oldid=1542