IKuznetsov в 09:29, 26 декабря 2024

2024-12-26T09:29:56Z

← Предыдущая версия		Версия от 09:29, 26 декабря 2024
Строка 8:		Строка 8:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs</nowiki></code>
	\|-		\|-

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

2024-12-24T14:09:54Z

← Предыдущая версия		Версия от 14:09, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / 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%97%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B9 Задания автообновлений] / GET АктивныхШлюзов с автообновлением заданий'''''

	Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.		Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.
Строка 279:		Строка 279:
	}		}
	]		]
	}~~</code>~~		}

IKuznetsov в 19:01, 23 декабря 2024

2024-12-23T19:01:01Z

← Предыдущая версия		Версия от 19:01, 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 АппОптима]] / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / GET АктивныхШлюзов с автообновлением заданий'''''

	Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.		Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.
Строка 255:		Строка 255:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"allUpdateJobs": [		"allUpdateJobs": [
	{		{

ENetrebin: Новая страница: «'''''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|Эндп...»

2024-06-02T20:45:43Z

Новая страница: «'''''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 Ключ-АСТРОМ]] / [[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 АктивныхШлюзов с автообновлением заданий'''''

Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs</nowiki></code>
|}
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение Read АктивныхШлюзов ( <code>activeGates.read</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|from
|string
|Начало запрошенного периода времени для заданий обновления.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
*Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
**<code>m</code>: минут
**<code>h</code>: часы
**<code>d</code>: дней
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не задано, используется относительный таймфрейм в один день ( <code>now-1d</code>).

Максимальный срок 31 день.
|запрос
|необязательный
|-
|to
|string
|Конец запрошенного периода времени для заданий обновления.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
*Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
**<code>m</code>: минут
**<code>h</code>: часы
**<code>d</code>: дней
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется текущая метка времени.
|запрос
|необязательный
|-
|startVersionCompareType
|string
|Фильтрует результирующий набор заданий обновления по указанной исходной версии.
Укажите здесь оператор сравнения.

Элемент может содержать эти значения
*<code>EQUAL</code>
*<code>GREATER</code>
*<code>GREATER_EQUAL</code>
*<code>LOWER</code>
*<code>LOWER_EQUAL</code>
|запрос
|необязательный
|-
|стартовая версия
|string
|Фильтрует результирующий набор update-jobs по начальной версии (обязательный формат <code><major>.<minor>.<revision></code>).
|запрос
|необязательный
|-
|тип обновления
|string
|Фильтрует результирующий набор заданий обновления по типу обновления.
Элемент может содержать эти значения
*<code>ACTIVE_GATE</code>
*<code>REMOTE_PLUGIN_AGENT</code>
*<code>SYNTHETIC</code>
*<code>Z_REMOTE</code>
|запрос
|необязательный
|-
|targetVersionCompareType
|string
|Фильтрует результирующий набор заданий обновления по указанной целевой версии.
Укажите здесь оператор сравнения.

Элемент может содержать эти значения
*<code>EQUAL</code>
*<code>GREATER</code>
*<code>GREATER_EQUAL</code>
*<code>LOWER</code>
*<code>LOWER_EQUAL</code>
|запрос
|необязательный
|-
|целевая версия
|string
|Фильтрует результирующий набор заданий обновления по целевой версии (обязательный формат <code><major>.<minor>.<revision></code>).
|запрос
|необязательный
|-
|последние обновления
|логический
|Если <code>true</code>, результирующий набор заданий обновления отфильтровывается до самого последнего обновления каждого типа.
|запрос
|необязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Обновить Вакансии Все
|Успех
|-
|400
|Конверт ошибки
|Не удалось. Ввод недействителен.
|}
===Объекты тела ответа===
====Объект <code>UpdateJobsAll</code>====
Список АктивныхШлюзов с заданиями на обновление.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|всеобновитьработы
|Обновить список заданий []
|Список АктивныхШлюзов с заданиями на обновление.
Может быть <code>null</code>.
|}
====Объект <code>UpdateJobList</code>====
Список заданий обновления АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|agId
|string
|Идентификатор АктивногоШлюза.
Может быть <code>null</code>.
|-
|обновлениеJobs
|Обновить задание []
|Список заданий обновления АктивногоШлюза.
Может быть <code>null</code>.
|}
====Объект <code>UpdateJob</code>====
Настройка задания обновления АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|jobState
|string
|Статус задания обновления.
Элемент может содержать эти значения
*<code>FAILED</code>
*<code>IN_PROGRESS</code>
*<code>PENDING</code>
*<code>ROLLBACK</code>
*<code>SCHEDULED</code>
*<code>SKIPPED</code>
*<code>SUCCEED</code>
Может быть <code>null</code>.
|-
|метод обновления
|string
|Способ обновления АктивногоШлюза или его компонентов.
Элемент может содержать эти значения
*<code>AUTOMATIC</code>
*<code>MANUAL_INSTALLATION</code>
*<code>ON_DEMAND</code>
Может быть <code>null</code>.
|-
|тип обновления
|string
|Компонент, который нужно обновить.
Элемент может содержать эти значения
*<code>ACTIVE_GATE</code>
*<code>REMOTE_PLUGIN_AGENT</code>
*<code>SYNTHETIC</code>
*<code>Z_REMOTE</code>
Может быть <code>null</code>.
|-
|agType
|string
|Тип АктивногоШлюза.
Элемент может содержать эти значения
*<code>CLUSTER</code>
*<code>ENVIRONMENT</code>
*<code>ENVIRONMENT_MULTI</code>
Может быть <code>null</code>.
|-
|стартовая версия
|string
|Начальная версия АктивногоШлюза.
Может быть <code>null</code>.
|-
|среды
|string []
|Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
Может быть <code>null</code>.
|-
|отменяемый
|логический
|Задание может ( <code>true</code>) или не может ( <code>false</code>) быть отменено в данный момент.
Может быть <code>null</code>.
|-
|идентификатор задания
|string
|Идентификатор задания обновления.
Может быть <code>null</code>.
|-
|отметка времени
|целое число
|Отметка времени завершения задания обновления.
Значение <code>null</code>означает, что задание все еще выполняется.

Может быть <code>null</code>.
|-
|продолжительность
|целое число
|Продолжительность обновления в миллисекундах.
Может быть <code>null</code>.
|-
|целевая версия
|string
|Целевая версия обновления.
Укажите версию в <code><major>.<minor>.<revision>.<timestamp></code>формате.

Чтобы обновить до последней доступной версии, используйте <code>latest</code>значение.
|-
|ошибка
|string
|Информация об ошибке обновления.
Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"allUpdateJobs": [
{
"agId": "0x3efdd092",
"updateJobs": [
{
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "ACTIVE_GATE",
"agType": "ENVIRONMENT",
"startVersion": "1.185.0.20200201-120000",
"environments": [
"string"
],
"cancelable": false,
"jobId": "-3524498778810258605",
"timestamp": 1582031917814,
"duration": 3608000,
"targetVersion": "1.190.0.20200301-130000",
"error": "string"
}
]
}
]
}</code>

GET АктивныхШлюзов с автообновлением заданий - История изменений

IKuznetsov в 09:29, 26 декабря 2024

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

IKuznetsov в 19:01, 23 декабря 2024

ENetrebin: Новая страница: «'''''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|Эндп...»