Получить все задания автообновления - История изменений

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

2024-12-26T09:33:11Z

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

	=== Модель JSON тела ответа ===		=== Модель JSON тела ответа ===
	<~~code>~~{		<{
	"agId": "0x3efdd092",		"agId": "0x3efdd092",
	"updateJobs": [		"updateJobs": [
Строка 305:		Строка 305:

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

Строка 312:		Строка 312:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"agId": "2100855201",		"agId": "2100855201",
	"updateJobs": [		"updateJobs": [

ENetrebin в 18:38, 11 декабря 2023

2023-12-11T18:38:22Z

← Предыдущая версия		Версия от 18:38, 11 декабря 2023
Строка 3:		Строка 3:
	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|ПОЛУЧИТЬ		\| rowspan="2" \|ПОЛУЧИТЬ
	\|~~Удалось~~		\|Managed
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
	\|-		\|-
	~~\|SaaS~~		\|Среда АктивногоШлюза
	~~\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs</nowiki></code>~~
	\|-
	\|Среда ~~ActiveGate~~
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
	\|}		\|}

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

	== Параметры ==		== Параметры ==
Строка 27:		Строка 24:
	\|стареть		\|стареть
	\|нить		\|нить
	\|ID необходимого ~~ActiveGate~~.		\|ID необходимого АктивногоШлюза.
	\|дорожка		\|дорожка
	\|по желанию		\|по желанию
Строка 223:		Строка 220:
	\|agType		\|agType
	\|нить		\|нить
	\|Тип ~~ActiveGate~~.		\|Тип АктивногоШлюза.

	Элемент может содержать эти значения		Элемент может содержать эти значения
Строка 234:		Строка 231:
	\|startVersion		\|startVersion
	\|нить		\|нить
	\|Первоначальная версия ~~ActiveGate~~.		\|Первоначальная версия АктивногоШлюза.
	\|по желанию		\|по желанию
	\|-		\|-
	\|окружающая среда		\|окружающая среда
	\|строка []		\|строка []
	\|Список сред (заданных идентификаторами), к которым ~~ActiveGate~~ может подключиться.		\|Список сред (заданных идентификаторами), к которым АктивногоШлюза может подключиться.
	\|по желанию		\|по желанию
	\|-		\|-

ENetrebin: Новая страница: «Перечисляет все задания обновления для указанного ActiveGate. Список включает завершенные з...»

2021-12-20T05:20:24Z

Новая страница: «Перечисляет все задания обновления для указанного ActiveGate. Список включает завершенные з...»

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

Перечисляет все задания обновления для указанного ActiveGate. Список включает завершенные задания (успешные или неудачные) и незавершенные.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!необходимые
|-
|стареть
|нить
|ID необходимого ActiveGate.
|дорожка
|по желанию
|-
|от
|нить
|Начало запрошенного периода времени для обновлений.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах 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-1w</code>).

Максимальный срок - 31 день.
|запрос
|обязательный
|-
|к
|нить
|Конец запрошенного периода для обновлений.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах 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
|нить
|Фильтрует полученный набор заданий обновления по указанной начальной версии.

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

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

* <code>EQUAL</code>
* <code>GREATER</code>
* <code>GREATER_EQUAL</code>
* <code>LOWER</code>
* <code>LOWER_EQUAL</code>
|запрос
|обязательный
|-
|startVersion
|нить
|Фильтрует полученный набор обновлений по исходной версии (требуемый формат <code><major>.<minor>.<revision></code>).
|запрос
|обязательный
|-
|updateType
|нить
|Фильтрует результирующий набор обновлений по типу обновления.

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

* <code>ACTIVE_GATE</code>
* <code>REMOTE_PLUGIN_AGENT</code>
* <code>SYNTHETIC</code>
* <code>Z_REMOTE</code>
|запрос
|обязательный
|-
|targetVersionCompareType
|нить
|Фильтрует полученный набор заданий обновления по указанной целевой версии.

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

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

* <code>EQUAL</code>
* <code>GREATER</code>
* <code>GREATER_EQUAL</code>
* <code>LOWER</code>
* <code>LOWER_EQUAL</code>
|запрос
|обязательный
|-
|targetVersion
|нить
|Фильтрует результирующий набор обновлений по целевой версии (требуемый формат <code><major>.<minor>.<revision></code>).
|запрос
|обязательный
|-
|lastUpdates
|логический
|Если <code>true</code>, фильтрует результирующий набор заданий обновления до самых последних обновлений каждого типа.
|запрос
|обязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Обновить список вакансий
|Успех
|-
|404
|Конверт ошибки
|Не найден. См. Подробности в теле ответа.
|}

=== Объекты тела ответа ===

==== объект <code>UpdateJobList</code> ====
Список обновлений ActiveGate.
{| class="wikitable"
!Элемент
!Тип
!Описание
!необходимые
|-
|стареть
|нить
|Идентификатор ActiveGate.
|по желанию
|-
|updateJobs
|Обновить задание []
|Список обновлений ActiveGate.
|по желанию
|}

==== объект <code>UpdateJob</code> ====
Конфигурация задания обновления ActiveGate.
{| class="wikitable"
!Элемент
!Тип
!Описание
!необходимые
|-
|jobState
|нить
|Статус задания обновления.

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

* <code>FAILED</code>
* <code>IN_PROGRESS</code>
* <code>PENDING</code>
* <code>ROLLBACK</code>
* <code>SCHEDULED</code>
* <code>SKIPPED</code>
* <code>SUCCEED</code>
|по желанию
|-
|updateMethod
|нить
|Метод обновления ActiveGate или его компонента.

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

* <code>AUTOMATIC</code>
* <code>MANUAL_INSTALLATION</code>
* <code>ON_DEMAND</code>
|по желанию
|-
|updateType
|нить
|Компонент, который нужно обновить.

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

* <code>ACTIVE_GATE</code>
* <code>REMOTE_PLUGIN_AGENT</code>
* <code>SYNTHETIC</code>
* <code>Z_REMOTE</code>
|по желанию
|-
|agType
|нить
|Тип ActiveGate.

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

* <code>CLUSTER</code>
* <code>ENVIRONMENT</code>
* <code>ENVIRONMENT_MULTI</code>
|по желанию
|-
|startVersion
|нить
|Первоначальная версия ActiveGate.
|по желанию
|-
|окружающая среда
|строка []
|Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.
|по желанию
|-
|отменяемый
|логический
|В настоящий момент задание можно ( <code>true</code>) или нельзя ( <code>false</code>) отменить.
|по желанию
|-
|jobId
|нить
|Идентификатор задания обновления.
|по желанию
|-
|отметка времени
|целое число
|Отметка времени завершения задания обновления.

<code>null</code>Значение означает , что работа по - прежнему работает.
|по желанию
|-
|продолжительность
|целое число
|Продолжительность обновления в миллисекундах.
|по желанию
|-
|targetVersion
|нить
|Целевая версия обновления.

Укажите версию в <code><major>.<minor>.<revision>.<timestamp></code>формате.

Чтобы обновить до последней доступной версии, используйте <code>latest</code>значение.
|обязательный
|-
|ошибка
|нить
|Информация об ошибке обновления.
|по желанию
|}

=== Модель JSON тела ответа ===
<code>{
"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>

== Пример ==
В этом примере в запросе перечислены все задания автоматического обновления ActiveGate с идентификатором 2100855201 .

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

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

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

==== Тело ответа ====
<code>{
"agId": "2100855201",
"updateJobs": [
{
"jobId": "-3137933319273211278",
"jobState": "SUCCEED",
"updateMethod": "MANUAL_INSTALLATION",
"updateType": "ACTIVE_GATE",
"cancelable": false,
"startVersion": "1.198.0.20200629-221007",
"targetVersion": "1.198.0.20200630-163221",
"timestamp": 1593683526719,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 556574
},
{
"jobId": "-6733215466838702651",
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "REMOTE_PLUGIN_AGENT",
"cancelable": false,
"startVersion": "1.198.0.20200629-123323",
"targetVersion": "1.198.0.20200630-155408",
"timestamp": 1593545522797,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 42669
}
]
}</code>

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