GET информацию о конкретном АктивномШлюзе - История изменений

IKuznetsov в 14:04, 24 декабря 2024

2024-12-24T14:04:38Z

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

IKuznetsov в 14:04, 24 декабря 2024

2024-12-24T14:04:25Z

← Предыдущая версия		Версия от 14:04, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / Эндпойнты среды / [~~[API Ключ~~-~~АСТРОМ~~#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|АктивныеШлюзы]] / Информация / GET информацию о конкретном АктивномШлюзе'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B5%D0%A8%D0%BB%D1%8E%D0%B7%D1%8B,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%98%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8F,-GET%20%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8E%20%D0%BE Информация] / GET информацию о конкретном АктивномШлюзе'''''

	Получает информацию об указанном АктивномШлюзе.		Получает информацию об указанном АктивномШлюзе.
Строка 199:		Строка 199:
	],		],
	"containerized": true		"containerized": true
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 876651882 .		В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 876651882 .
Строка 206:		Строка 206:
	====Curl====		====Curl====
	<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882</nowiki></code>
Строка 227:		Строка 227:
	],		],
	"networkZone": "easytravel.europe.austria.05"		"networkZone": "easytravel.europe.austria.05"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	200		200

IKuznetsov в 18:48, 23 декабря 2024

2024-12-23T18:48:51Z

← Предыдущая версия		Версия от 18:48, 23 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / ~~[[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|~~Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|АктивныеШлюзы]] / Информация / GET информацию о конкретном АктивномШлюзе'''''		'''''[[API АппОптима]] / Эндпойнты среды / [[API Ключ-АСТРОМ#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|АктивныеШлюзы]] / Информация / GET информацию о конкретном АктивномШлюзе'''''

	Получает информацию об указанном АктивномШлюзе.		Получает информацию об указанном АктивномШлюзе.
Строка 165:		Строка 165:
	\|}		\|}
	*Модель JSON		*Модель JSON
	<~~code>~~{		<{
	"id": "0x3efdd091",		"id": "0x3efdd091",
	"networkAddresses": [		"networkAddresses": [
Строка 205:		Строка 205:
	Токен API передается в заголовке авторизации .		Токен API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl -L -X GET '<nowiki>https://mySampleEnv.live.~~astromkey~~.com/api/v2/activeGates/876651882'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv.live.~~astromkey~~.com/api/v2/activeGates/876651882</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/876651882</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"id": "876651882",		"id": "876651882",
	"networkAddresses": [		"networkAddresses": [

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

2024-06-05T15:02:09Z

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

← Предыдущая версия		Версия от 15:02, 5 июня 2024
Строка 127:		Строка 127:
	\|-		\|-
	\|тип		\|тип
	\|~~нить~~		\|string
	\|Тип модуля АктивногоШлюза.		\|Тип модуля АктивногоШлюза.
	Элемент может содержать эти значения		Элемент может содержать эти значения
Строка 136:		Строка 136:
	\|-		\|-
	\|версия		\|версия
	\|~~нить~~		\|string
	\|Версия модуля АктивногоШлюза.		\|Версия модуля АктивногоШлюза.
	\|-		\|-

ENetrebin: /* Curl */

2024-06-05T15:00:58Z

Curl

← Предыдущая версия		Версия от 15:00, 5 июня 2024
Строка 205:		Строка 205:
	Токен API передается в заголовке авторизации .		Токен API передается в заголовке авторизации .
	====Curl====		====Curl====
	<code>curl -L -X GET '<nowiki>https://mySampleEnv/api/v2/activeGates/876651882'</nowiki> \		<code>curl -L -X GET '<nowiki>https://mySampleEnv.live.astromkey.com/api/v2/activeGates/876651882'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv/api/v2/activeGates/876651882</nowiki></code>		<code><nowiki>https://mySampleEnv.live.astromkey.com/api/v2/activeGates/876651882</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<code>{		<code>{

ENetrebin в 16:53, 2 июня 2024

2024-06-02T16:53:03Z

← Предыдущая версия		Версия от 16:53, 2 июня 2024
Строка 1:		Строка 1:
			'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|АктивныеШлюзы]] / Информация / GET информацию о конкретном АктивномШлюзе'''''

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

ENetrebin: Новая страница: «Получает информацию об указанном АктивномШлюзе. Запрос создает `application/json`полезну...»

2024-06-02T16:50:20Z

Новая страница: «Получает информацию об указанном АктивномШлюзе. Запрос создает <code>application/json</code>полезну...»

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

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
|GET
|
*Managed https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / {agId}
*Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / {agId}.
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов ( <code>activeGates.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!необходимость
|-
|старение
|string
|ID необходимого АктивногоШлюза.
|path
|обязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
!Описание
|-
|200
|Успех
|-
|404
|Не найден. См. Подробности в теле ответа.
|}
===Тело ответа===
*Параметры ответа
====АктивныйШлюз объект====
Параметры АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор АктивногоШлюза.
|-
|networkAddresses
|string []
|Список сетевых адресов АктивногоШлюза.
|-
|loadBalancerAddresses
|string []
|Список адресов Load Balancer АктивногоШлюза.
|-
|osType
|string
|Тип ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
|-
|autoUpdateStatus
|string
|Текущий статус автообновлений АктивногоШлюза.
Элемент может содержать эти значения
|-
|offline
|целое число
|Отметка времени, с которой АктивныйШлюз отключен.
<code>null</code>Значение означает АктивныйШлюз онлайн.
|-
|версия
|string
|Текущая версия АктивногоШлюза в <code><major>.<minor>.<revision>.<timestamp></code>формате.
|-
|тип
|string
|Тип АктивногоШлюза.
Элемент может содержать эти значения
|-
|имя хоста
|string
|Имя хоста, на котором работает АктивныйШлюз.
|-
|mainEnvironment
|string
|Идентификатор основной среды для АктивногоШлюза с несколькими средами.
|-
|окружающая среда
|string[]
|Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
|-
|autoUpdateSettings
|АктивныйШлюз Auto Update Config
|
|-
|networkZone
|string
|Сетевая зона АктивногоШлюза.
|-
|группа
|string
|Группа АктивногоШлюза.
|-
|модули
|АктивныйШлюз модуль []
|Список модулей АктивногоШлюза.
|-
|контейнерный
|логический
|АктивныйШлюз развертывается в контейнере ( <code>true</code>) или нет ( <code>false</code>).
|}
====Модуль АктивногоШлюза====
Информация о модуле АктивногоШлюза
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|неправильно настроен
|логический
|Модуль неправильно сконфигурирован ( <code>true</code>) или нет ( <code>false</code>).
|-
|тип
|нить
|Тип модуля АктивногоШлюза.
Элемент может содержать эти значения
|-
|атрибуты
|объект
|Атрибуты модуля АктивногоШлюза.
|-
|версия
|нить
|Версия модуля АктивногоШлюза.
|-
|включено
|логический
|Модуль включен ( <code>true</code>) или отключен ( <code>false</code>).
|}
====ActiveGateAutoUpdateConfig объект====
Настройка автообновлений АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|параметр
|string
|Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
Если установлено значение <code>INHERITED</code>, параметр наследуется из глобальной конфигурации, установленной на уровне среды или управляемого кластера.

Элемент может содержать эти значения
|-
|EffectiveSetting
|string
|Фактическое состояние автообновления АктивногоШлюза.
Применимо, только если параметр настройки установлен на <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>
==Пример==
В этом примере в запросе перечислены параметры АктивногоШлюза с идентификатором 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

GET информацию о конкретном АктивномШлюзе - История изменений

IKuznetsov в 14:04, 24 декабря 2024

IKuznetsov в 14:04, 24 декабря 2024

IKuznetsov в 18:48, 23 декабря 2024

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

ENetrebin: /* Curl */

ENetrebin в 16:53, 2 июня 2024

ENetrebin: Новая страница: «Получает информацию об указанном АктивномШлюзе. Запрос создает application/jsonполезну...»

ENetrebin: Новая страница: «Получает информацию об указанном АктивномШлюзе. Запрос создает `application/json`полезну...»