GET информацию о всех АктивныхШлюзах: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) (→Curl) |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 1: | Строка 1: | ||
'''''[https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C API Ключ-АСТРОМ] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.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 информацию о всех АктивныхШлюзах''''' | |||
Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов. | Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 2 часов. | ||
Строка 435: | Строка 437: | ||
Результат усекается до двух записей. | Результат усекается до двух записей. | ||
====Curl==== | ====Curl==== | ||
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live. | <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.astromkey.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.astromkey.ru/api/v2/activeGates</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
<code>{ | <code>{ |
Текущая версия на 14:59, 5 июня 2024
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Информация / GET информацию о всех АктивныхШлюзах
Перечисляет все АктивныеШлюзы, которые в настоящее время подключены к среде или были подключены в течение последних 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 | Фильтрует результирующий набор АктивныхШлюзов на те, у которых токен авторизации находится в указанном состоянии.
Элемент может содержать эти значения
|
query | по желанию |
tokenExpirationSet | boolean | Фильтрует результирующий набор АктивныхШлюзов на те, у которых установлена дата истечения срока действия токена авторизации. | query | по желанию |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Список активных шлюзов | Успех |
400 | ErrorEnvelope | Неуспешно. Ввод недействителен. |
Объекты тела ответа
Объект ActiveGateList
Список АктивныхШлюзов.
Элемент | Тип | Описание |
---|---|---|
ActiveGate | ActiveGate [] | Список АктивногоШлюза. |
Объект ActiveGate
Параметры АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
идентификатор | string | Идентификатор АктивногоШлюза. |
сетевые адреса | string [] | Список сетевых адресов АктивногоШлюза. |
loadBalancerAddresses | string [] | Список адресов балансировщика нагрузки АктивногоШлюза. |
тип ОС | string | Тип ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
|
ОСАрхитектура | string | Архитектура ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
|
осбитнесс | string | Разрядность ОС, на которой работает АктивныйШлюз.
Элемент может содержать эти значения
|
autoUpdateStatus | string | Текущий статус автообновлений АктивногоШлюза.
Элемент может содержать эти значения
|
offlineSince | целое число | Отметка времени с момента, когда АктивныйШлюз находится в автономном режиме.
Значение |
версия | string | Текущая версия АктивногоШлюза в <major>.<minor>.<revision>.<timestamp> формате.
|
тип | string | Тип АктивногоШлюза.
Элемент может содержать эти значения
|
имя хоста | string | Имя хоста, на котором работает АктивныйШлюз. |
mainEnvironment | string | Идентификатор основной среды для АктивногоШлюза с несколькими средами. |
среды | string [] | Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз. |
автообновление настроек | Конфигурация автоматического обновления АктивногоШлюза | Настройка автообновлений АктивногоШлюза. |
networkZone | string | Сетевая зона АктивногоШлюза. |
группа | string | Группа АктивногоШлюз. |
модули | Модуль АктивногоШлюза [] | Список модулей АктивногоШлюза. |
контейнерный | логический | АктивныйШлюз развернут в контейнере ( true ) или нет ( false ).
|
подключенные хосты | Хосты , подключенные к АктивномуШлюзу | Информация о хостах, подключенных в данный момент к АктивногоШлюза |
ActiveGateTokens | Информация о токене АктивногоШлюза Dto [] | Список токенов АктивногоШлюза. |
Объект ActiveGateAutoUpdateConfig
Настройка автообновлений АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
параметр | string | Состояние автообновления АктивногоШлюза: включено, отключено или унаследовано.
Если установлено значение |
эффективная настройка | string | Фактическое состояние автообновления АктивногоШлюза.
Применимо, только если для параметра настройки установлено значение |
Объект ActiveGateModule
Информация о модуле АктивногоШлюза
Элемент | Тип | Описание |
---|---|---|
неправильно сконфигурирован | логический | Модуль неправильно сконфигурирован ( true ) или нет ( false ).
|
версия | string | Версия модуля АктивногоШлюза. |
включено | логический | Модуль включен ( true ) или отключен ( false ).
|
тип | string | Тип модуля АктивногоШлюза.
Элемент может содержать эти значения |
атрибуты | объект | Атрибуты модуля АктивногоШлюза. |
Объект ActiveGateConnectedHosts
Информация о хостах, подключенных в данный момент к АктивномуШлюзу
Элемент | Тип | Описание |
---|---|---|
число | целое число | Количество хостов, в настоящее время подключенных к АктивномуШлюзу |
Объект ActiveGateTokenInfoDto
Информация о токене АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
идентификатор среды | string | Идентификатор среды, к которой принадлежит токен.
Доступно, только если поддерживается более одной среды. |
идентификатор | string | Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена. |
состояние | string | Состояние токена АктивногоШлюза.
Элемент может содержать эти значения |
JSON-модель тела ответа
{
"activeGates": [
{
"id": "0x3efdd091",
"networkAddresses": [
"string"
],
"loadBalancerAddresses": [
"string"
],
"osType": "WINDOWS",
"osArchitecture": "X86",
"osBitness": "64",
"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,
"version": "string",
"enabled": true,
"type": "KUBERNETES",
"attributes": {}
}
],
"containerized": true,
"connectedHosts": {
"number": 150
},
"activeGateTokens": [
{
"environmentId": "string",
"id": "dt0g02.4KWZO5EF",
"state": "ABSENT"
}
]
}
]
}
Пример
В этом примере в запросе перечислены все АктивныеШлюзы, доступные для среды mySampleEnv .
Маркер API передается в заголовке авторизации .
Результат усекается до двух записей.
Curl
curl -L -X GET 'https://mySampleEnv.live.astromkey.ru/api/v2/activeGates' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.astromkey.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