Получить информацию о всех АктивныхШлюзах: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Перечисляет все ActiveGates, которые в настоящее время подключены к среде или были подключены...») |
ENetrebin (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
Перечисляет все | Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов. | ||
Вы можете сузить вывод, указав параметры фильтрации в своем запросе. | Вы можете сузить вывод, указав параметры фильтрации в своем запросе. | ||
Запрос создает <code>application/json</code> | Запрос создает в качестве полезной нагрузки <code>application/json</code>формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |GET | ||
| | | | ||
* | * Managed https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates | ||
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates | |||
* Среда | |||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение | Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов ( <code>activeGates.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Строка 20: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !необходимость | ||
|- | |- | ||
| | |hostname | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по имени хоста, на котором он работает. | ||
Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
|osType | |osType | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по типу ОС хоста, на котором он работает. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |||
* <code>LINUX</code> | |||
* <code>WINDOWS</code> | |||
|query | |||
|по желанию | |по желанию | ||
|- | |- | ||
| | |networkAddress | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по сетевому адресу. | ||
Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор. | Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
|loadBalancerAddress | |loadBalancerAddress | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по адресу Load Balancer. | ||
Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор. | Вы можете указать частичный адрес. В этом случае используется <code>CONTAINS</code>оператор. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивногоШлюза по типу АктивногоШлюза. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |||
* <code>ENVIRONMENT</code> | |||
* <code>ENVIRONMENT_MULTI</code> | |||
|query | |||
|по желанию | |по желанию | ||
|- | |- | ||
|networkZone | |networkZone | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по сетевой зоне. | ||
Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |updateStatus | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по статусу автообновления. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |||
* <code>INCOMPATIBLE</code> | |||
* <code>OUTDATED</code> | |||
* <code>SCHEDULED</code> | |||
* <code>SUPPRESSED</code> | |||
* <code>UNKNOWN</code> | |||
* <code>UP2DATE</code> | |||
* <code>UPDATE_IN_PROGRESS</code> | |||
* <code>UPDATE_PENDING</code> | |||
* <code>UPDATE_PROBLEM</code> | |||
|query | |||
|по желанию | |по желанию | ||
|- | |- | ||
|versionCompareType | |versionCompareType | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по указанной версии. | ||
Укажите здесь оператор сравнения. | Укажите здесь оператор сравнения. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |||
* <code>EQUAL</code> | |||
* <code>GREATER</code> | |||
* <code>GREATER_EQUAL</code> | |||
* <code>LOWER</code> | |||
* <code>LOWER_EQUAL</code> | |||
|query | |||
|по желанию | |по желанию | ||
|- | |- | ||
| | |version | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по указанной версии. | ||
Здесь укажите версию в <code><major>.<minor>.<revision></code>формате (например, <code>1.195.0</code>). | Здесь укажите версию в <code><major>.<minor>.<revision></code>формате (например, <code>1.195.0</code>). | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |autoUpdate | ||
| | |string | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по фактическому состоянию автообновления. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| | |||
* <code>DISABLED</code> | |||
* <code>ENABLED</code> | |||
|query | |||
|по желанию | |по желанию | ||
|- | |- | ||
| | |group | ||
| | |string | ||
|Фильтрует результирующий набор | |Фильтрует результирующий набор АктивныхШлюзов по группе. | ||
Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | Вы можете указать частичное имя. В этом случае используется <code>CONTAINS</code>оператор. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |online | ||
| | |boolean | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по статусу связи. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
|enabledModule | |enabledModule | ||
| | |string[] | ||
|Фильтрует результирующий набор | |Фильтрует результирующий набор АктивныхШлюзов по включенным модулям. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
|disabledModule | |disabledModule | ||
| | |string[] | ||
|Фильтрует полученный набор | |Фильтрует полученный набор АктивныхШлюзов по отключенным модулям. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |containerized | ||
| | |boolean | ||
|Отфильтровывает результирующий набор | |Отфильтровывает результирующий набор АктивныхШлюзов к тем, которые работают в контейнере ( <code>true</code>) или нет ( <code>false</code>). | ||
| | |query | ||
|по желанию | |||
|- | |||
|tokenState | |||
|string | |||
|Фильтрует результирующий набор ActiveGates на те, у которых токен авторизации находится в указанном состоянии. | |||
Элемент может содержать эти значения | |||
* <code>ABSENT</code> | |||
* <code>EXPIRING</code> | |||
* <code>INVALID</code> | |||
* <code>UNKNOWN</code> | |||
* <code>UNSUPPORTED</code> | |||
* <code>VALID</code> | |||
|query | |||
|по желанию | |||
|- | |||
|tokenExpirationSet | |||
|boolean | |||
|Фильтрует результирующий набор АктивныхШлюзов на те, у которых установлена дата истечения срока действия токена авторизации. | |||
|query | |||
|по желанию | |по желанию | ||
|} | |} | ||
Строка 157: | Строка 201: | ||
==== ActiveGateList объект ==== | ==== ActiveGateList объект ==== | ||
Список | Список АктивныхШлюзов. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 165: | Строка 209: | ||
|activeGates | |activeGates | ||
|ActiveGate [] | |ActiveGate [] | ||
|Список | |Список АктивныхШлюзов. | ||
|} | |} | ||
==== ActiveGate объект ==== | ==== ActiveGate объект ==== | ||
Параметры | Параметры АктивногоШлюза. | ||
==== ActiveGateModule объект ==== | ==== ActiveGateModule объект ==== | ||
Строка 396: | Строка 346: | ||
==== Завиток ==== | ==== Завиток ==== | ||
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live. | <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. | <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates</nowiki></code> | ||
==== Тело ответа ==== | ==== Тело ответа ==== |
Версия 16:53, 22 февраля 2023
Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов.
Вы можете сузить вывод, указав параметры фильтрации в своем запросе.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET |
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов ( activeGates.read
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | необходимость |
---|---|---|---|---|
hostname | string | Фильтрует полученный набор АктивныхШлюзов по имени хоста, на котором он работает.
Вы можете указать частичное имя. В этом случае используется |
query | по желанию |
osType | string | Фильтрует полученный набор АктивныхШлюзов по типу ОС хоста, на котором он работает.
Элемент может содержать эти значения
|
query | по желанию |
networkAddress | string | Фильтрует полученный набор АктивныхШлюзов по сетевому адресу.
Вы можете указать частичный адрес. В этом случае используется |
query | по желанию |
loadBalancerAddress | string | Фильтрует полученный набор АктивныхШлюзов по адресу Load Balancer.
Вы можете указать частичный адрес. В этом случае используется |
query | по желанию |
type | string | Фильтрует полученный набор АктивногоШлюза по типу АктивногоШлюза.
Элемент может содержать эти значения
|
query | по желанию |
networkZone | string | Фильтрует полученный набор АктивныхШлюзов по сетевой зоне.
Вы можете указать частичное имя. В этом случае используется |
query | по желанию |
updateStatus | string | Фильтрует полученный набор АктивныхШлюзов по статусу автообновления.
Элемент может содержать эти значения
|
query | по желанию |
versionCompareType | string | Фильтрует полученный набор АктивныхШлюзов по указанной версии.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
query | по желанию |
version | string | Фильтрует полученный набор АктивныхШлюзов по указанной версии.
Здесь укажите версию в |
query | по желанию |
autoUpdate | string | Фильтрует полученный набор АктивныхШлюзов по фактическому состоянию автообновления.
Элемент может содержать эти значения
|
query | по желанию |
group | string | Фильтрует результирующий набор АктивныхШлюзов по группе.
Вы можете указать частичное имя. В этом случае используется |
query | по желанию |
online | boolean | Фильтрует полученный набор АктивныхШлюзов по статусу связи. | query | по желанию |
enabledModule | string[] | Фильтрует результирующий набор АктивныхШлюзов по включенным модулям. | query | по желанию |
disabledModule | string[] | Фильтрует полученный набор АктивныхШлюзов по отключенным модулям. | query | по желанию |
containerized | boolean | Отфильтровывает результирующий набор АктивныхШлюзов к тем, которые работают в контейнере ( true ) или нет ( false ).
|
query | по желанию |
tokenState | string | Фильтрует результирующий набор ActiveGates на те, у которых токен авторизации находится в указанном состоянии.
Элемент может содержать эти значения
|
query | по желанию |
tokenExpirationSet | boolean | Фильтрует результирующий набор АктивныхШлюзов на те, у которых установлена дата истечения срока действия токена авторизации. | query | по желанию |
Ответ
Коды ответов
Код | Описание |
---|---|
200 | Успех |
400 | Не удалось. Введены неверные данные. |
Тело ответа
- Параметры ответа
ActiveGateList объект
Список АктивныхШлюзов.
Элемент | Тип | Описание |
---|---|---|
activeGates | ActiveGate [] | Список АктивныхШлюзов. |
ActiveGate объект
Параметры АктивногоШлюза.
ActiveGateModule объект
Информация о модуле ActiveGate
Элемент | Тип | Описание |
---|---|---|
неправильно настроен | логический | Модуль неправильно сконфигурирован ( true ) или нет ( false ).
|
тип | нить | Тип модуля ActiveGate.
Элемент может содержать эти значения
|
атрибуты | объект | Атрибуты модуля ActiveGate. |
версия | нить | Версия модуля ActiveGate. |
включено | логический | Модуль включен ( true ) или отключен ( false ).
|
ActiveGateAutoUpdateConfig объект
Настройка автообновлений ActiveGate.
Элемент | Тип | Описание |
---|---|---|
параметр | нить | Состояние автообновления ActiveGate: включено, отключено или унаследовано.
Если установлено значение Элемент может содержать эти значения
|
EffectiveSetting | нить | Фактическое состояние автообновления ActiveGate.
Применимо, только если параметр настройки установлен на Элемент может содержать эти значения
|
- Модель JSON
{
"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
}
]
}
Пример
В этом примере в запросе перечислены все ActiveGates, доступные для среды mySampleEnv .
Токен API передается в заголовке авторизации .
Результат усекается до двух записей.
Завиток
curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates
Тело ответа
{
"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"
}
]
}
Код ответа
200