Получить информацию о всех АктивныхШлюзах - История изменений

IKuznetsov в 10:35, 26 декабря 2024

2024-12-26T10:35:39Z

← Предыдущая версия		Версия от 10:35, 26 декабря 2024
Строка 7:		Строка 7:
	\|GET		\|GET
	\|		\|
	* ~~Managed~~ https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates		* АппОптима https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates
	* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates		* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates
	\|}		\|}
Строка 426:		Строка 426:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"activeGates": [		"activeGates": [
	{		{
Строка 486:		Строка 486:

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

Строка 493:		Строка 493:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"activeGates": [		"activeGates": [
	{		{

ENetrebin в 16:40, 3 октября 2023

2023-10-03T16:40:14Z

Внесённые изменения

ENetrebin в 17:59, 21 сентября 2023

2023-09-21T17:59:12Z

← Предыдущая версия		Версия от 17:59, 21 сентября 2023
Строка 163:		Строка 163:
	\|tokenState		\|tokenState
	\|string		\|string
	\|Фильтрует результирующий набор ~~ActiveGates~~ на те, у которых токен авторизации находится в указанном состоянии.		\|Фильтрует результирующий набор АктивныхШлюзов на те, у которых токен авторизации находится в указанном состоянии.
	Элемент может содержать эти значения		Элемент может содержать эти значения

Строка 210:		Строка 210:
	\|активные ворота		\|активные ворота
	\|Активные ворота []		\|Активные ворота []
	\|Список ~~ActiveGate~~.		\|Список АктивногоШлюза.
	\|}		\|}

	==== Объект _ <code>ActiveGate</code> ====		==== Объект _ <code>ActiveGate</code> ====
	Параметры ~~ActiveGate~~.		Параметры АктивногоШлюза.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 222:		Строка 222:
	\|идентификатор		\|идентификатор
	\|нить		\|нить
	\|Идентификатор ~~ActiveGate~~.		\|Идентификатор АктивногоШлюза.
	\|-		\|-
	\|сетевые адреса		\|сетевые адреса
	\|строка []		\|строка []
	\|Список сетевых адресов ~~ActiveGate~~.		\|Список сетевых адресов АктивногоШлюза.
	\|-		\|-
	\|loadBalancerAddresses		\|loadBalancerAddresses
	\|строка []		\|строка []
	\|Список адресов балансировщика нагрузки ~~ActiveGate~~.		\|Список адресов балансировщика нагрузки АктивногоШлюза.
	\|-		\|-
	\|тип ОС		\|тип ОС

ENetrebin: /* Объект _ ActiveGateConnectedHosts */

2023-02-22T18:36:12Z

Объект _ ActiveGateConnectedHosts

← Предыдущая версия		Версия от 18:36, 22 февраля 2023
Строка 389:		Строка 389:
	\|}		\|}

	==== Объект _ <code>ActiveGateConnectedHosts</code> ====		==== Объект <code>ActiveGateConnectedHosts</code> ====
	Информация о хостах, подключенных в данный момент к ActiveGate		Информация о хостах, подключенных в данный момент к ActiveGate
	{\| class="wikitable"		{\| class="wikitable"

ENetrebin: /* Завиток */

2023-02-22T17:15:44Z

Завиток

← Предыдущая версия		Версия от 17:15, 22 февраля 2023
Строка 485:		Строка 485:
	Результат усекается до двух записей.		Результат усекается до двух записей.

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

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

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

ENetrebin: /* Ответ */

2023-02-22T17:14:01Z

Ответ

Внесённые изменения

ENetrebin: /* ActiveGate объект */

2023-02-22T17:04:55Z

ActiveGate объект

@@ Строка 214: / Строка 214: @@
 ==== ActiveGate объект ====
 Параметры АктивногоШлюза.
 ==== ActiveGateModule объект ====

ENetrebin в 16:53, 22 февраля 2023

2023-02-22T16:53:31Z

Внесённые изменения

ENetrebin: Новая страница: «Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены...»

2021-12-13T05:29:52Z

Новая страница: «Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены...»

Новая страница

Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов.

Вы можете сузить вывод, указав параметры фильтрации в своем запросе.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!необходимые
|-
|имя хоста
|нить
|Фильтрует полученный набор ActiveGates по имени хоста, на котором он работает.

Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор.
|запрос
|по желанию
|-
|osType
|нить
|Фильтрует полученный набор ActiveGates по типу ОС хоста, на котором он работает.

Элемент может содержать эти значения
|запрос
|по желанию
|-
|сетевой адрес
|нить
|Фильтрует полученный набор ActiveGates по сетевому адресу.

Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор.
|запрос
|по желанию
|-
|loadBalancerAddress
|нить
|Фильтрует полученный набор ActiveGates по адресу Load Balancer.

Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор.
|запрос
|по желанию
|-
|тип
|нить
|Фильтрует полученный набор ActiveGate по типу ActiveGate.

Элемент может содержать эти значения
|запрос
|по желанию
|-
|networkZone
|нить
|Фильтрует полученный набор ActiveGates по сетевой зоне.

Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор.
|запрос
|по желанию
|-
|обновить статус
|нить
|Фильтрует полученный набор ActiveGates по статусу автообновления.

Элемент может содержать эти значения
|запрос
|по желанию
|-
|versionCompareType
|нить
|Фильтрует полученный набор ActiveGates по указанной версии.

Укажите здесь оператор сравнения.

Элемент может содержать эти значения
|запрос
|по желанию
|-
|версия
|нить
|Фильтрует полученный набор ActiveGates по указанной версии.

Здесь укажите версию в <code><major>.<minor>.<revision></code>формате (например, <code>1.195.0</code>).
|запрос
|по желанию
|-
|автоматическое обновление
|нить
|Фильтрует полученный набор ActiveGates по фактическому состоянию автообновления.

Элемент может содержать эти значения
|запрос
|по желанию
|-
|группа
|нить
|Фильтрует результирующий набор ActiveGates по группе.

Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор.
|запрос
|по желанию
|-
|онлайн
|логический
|Фильтрует полученный набор ActiveGates по статусу связи.
|запрос
|по желанию
|-
|enabledModule
|множество
|Фильтрует результирующий набор ActiveGates по включенным модулям.
|запрос
|по желанию
|-
|disabledModule
|множество
|Фильтрует полученный набор ActiveGates по отключенным модулям.
|запрос
|по желанию
|-
|контейнерный
|логический
|Отфильтровывает результирующий набор ActiveGates к тем, которые работают в контейнере ( <code>true</code>) или нет ( <code>false</code>).
|запрос
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
!Описание
|-
|200
|Успех
|-
|400
|Не удалось. Введены неверные данные.
|}

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

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

==== ActiveGateList объект ====
Список ActiveGates.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|activeGates
|ActiveGate []
|Список ActiveGates.
|}

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

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

* LINUX
* ОКНА
|-
|autoUpdateStatus
|нить
|Текущий статус автообновлений ActiveGate.

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

* НЕСОВМЕСТИМО
* УСТАРЕЛО
* ПО РАСПИСАНИЮ
* ПОДДЕРЖИВАЕТСЯ
* НЕИЗВЕСТНЫЙ
* ОБНОВЛЕНИЕ
* ПРОИЗВОДИТСЯ ОБНОВЛЕНИЕ
* UPDATE_PENDING
* UPDATE_PROBLEM
|-
|offline
|целое число
|Отметка времени, с которой ActiveGate отключен.

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

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

* КЛАСТЕР
* ОКРУЖАЮЩАЯ ОБСТАНОВКА
* ENVIRONMENT_MULTI
|-
|имя хоста
|нить
|Имя хоста, на котором работает 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.

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

* AWS
* ЛАЗУРНЫЙ
* BEACON_FORWARDER
* CLOUD_FOUNDRY
* DB_INSIGHT
* EXTENSIONS_V1
* EXTENSIONS_V2
* КУБЕРНЕТЫ
* ЖУРНАЛЫ
* MEMORY_DUMPS
* METRIC_API
* ONE_AGENT_ROUTING
* OTLP_INGEST
* REST_API
* СИНТЕТИЧЕСКИЙ
* VMWARE
* Z_OS
|-
|атрибуты
|объект
|Атрибуты модуля ActiveGate.
|-
|версия
|нить
|Версия модуля ActiveGate.
|-
|включено
|логический
|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
|}

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

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

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

* ИНВАЛИД
* ВКЛЮЧЕНО
* Унаследованный
|-
|EffectiveSetting
|нить
|Фактическое состояние автообновления ActiveGate.

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

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

* ВКЛЮЧЕНО
* ИНВАЛИД
|}

* Модель JSON

<code>{
"activeGates": [
{
"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>

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

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

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

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

==== URL запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates</nowiki></code>

==== Тело ответа ====
<code>{
"activeGates": [
{
"id": "1541791174",
"networkAddresses": [
"orange-15.easytravel.com",
"150.134.11.6"
],
"osType": "LINUX",
"autoUpdateStatus": "UP2DATE",
"offlineSince": null,
"version": "1.193.0.20200416-144858",
"type": "ENVIRONMENT",
"hostname": "orange-15.easytravel.com",
"mainEnvironment": null,
"environments": [
"mySampleEnv"
],
"networkZone": "default"
},
{
"id": "974977376",
"networkAddresses": [
"win-18.easytravel.com",
"66.165.59.105"
],
"osType": "WINDOWS",
"autoUpdateStatus": "OUTDATED",
"offlineSince": null,
"version": "1.198.0.20200629-221007",
"type": "ENVIRONMENT",
"hostname": "win-18.easytravel.com",
"mainEnvironment": null,
"environments": [
"mySampleEnv"
],
"networkZone": "default"
}
]
}</code>

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