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

ENetrebin в 11:10, 4 апреля 2022

2022-04-04T11:10:22Z

← Предыдущая версия		Версия от 11:10, 4 апреля 2022
Строка 1:		Строка 1:
	Создает новое задание автоматического обновления для указанного ~~ActiveGate~~.		Создает новое задание автоматического обновления для указанного АктивногоШлюза.

	Задание обновляет ~~ActiveGate~~ до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий ~~ActiveGate~~ .		Задание обновляет АктивныйШлюз до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий АктивногоШлюза .

	Запрос потребляет и производит <code>application/json</code>полезную нагрузку.		Запрос потребляет и производит <code>application/json</code>полезную нагрузку.
Строка 12:		Строка 12:
	\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs</nowiki></code>		\|<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.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .		Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

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

	==== объект <code>UpdateJob</code> ====		==== объект <code>UpdateJob</code> ====
	Конфигурация задания обновления ~~ActiveGate~~.		Конфигурация задания обновления АктивногоШлюза.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 67:		Строка 67:
	\|updateMethod		\|updateMethod
	\|нить		\|нить
	\|Метод обновления ~~ActiveGate~~ или его компонента.		\|Метод обновления АктивногоШлюза или его компонента.

	Элемент может содержать эти значения		Элемент может содержать эти значения
Строка 90:		Строка 90:
	\|agType		\|agType
	\|нить		\|нить
	\|Тип ~~ActiveGate~~.		\|Тип АктивныйШлюз.

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

	==== объект <code>UpdateJob</code> ====		==== объект <code>UpdateJob</code> ====
	Конфигурация задания обновления ~~ActiveGate~~.		Конфигурация задания обновления АктивногоШлюза.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 209:		Строка 209:
	\|updateMethod		\|updateMethod
	\|нить		\|нить
	\|Метод обновления ~~ActiveGate~~ или его компонента.		\|Метод обновления АктивныйШлюз или его компонента.

	Элемент может содержать эти значения		Элемент может содержать эти значения
Строка 232:		Строка 232:
	\|agType		\|agType
	\|нить		\|нить
	\|Тип ~~ActiveGate~~.		\|Тип АктивныйШлюз.

	Элемент может содержать эти значения		Элемент может содержать эти значения
Строка 243:		Строка 243:
	\|startVersion		\|startVersion
	\|нить		\|нить
	\|Первоначальная версия ~~ActiveGate~~.		\|Первоначальная версия АктивныйШлюз.
	\|по желанию		\|по желанию
	\|-		\|-
	\|окружающая среда		\|окружающая среда
	\|строка []		\|строка []
	\|Список сред (заданных идентификаторами), к которым ~~ActiveGate~~ может подключиться.		\|Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
	\|по желанию		\|по желанию
	\|-		\|-
Строка 318:		Строка 318:
	\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>		\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
	\|-		\|-
	\|Среда ~~ActiveGate~~		\|Среда АктивныйШлюз
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
	\|}		\|}

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

	=== Ответ ===		=== Ответ ===
Строка 343:		Строка 343:

	== Пример ==		== Пример ==
	В этом примере запрос создает задание обновления для обновления ~~ActiveGate~~ с идентификатором 1812885988 до версии 1.198.0.20200630-163221 .		В этом примере запрос создает задание обновления для обновления АктивногоШлюза с идентификатором 1812885988 до версии 1.198.0.20200630-163221 .

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

ENetrebin в 07:53, 18 февраля 2022

2022-02-18T07:53:27Z

← Предыдущая версия		Версия от 07:53, 18 февраля 2022
Строка 1:		Строка 1:
	Создает новое задание автоматического обновления для указанного ActiveGate.		Создает новое задание автоматического обновления для указанного ActiveGate.

	Задание обновляет ActiveGate до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий ActiveGate .		Задание обновляет ActiveGate до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий ActiveGate .

ENetrebin: Новая страница: «Создает новое задание автоматического обновления для указанного ActiveGate. Задание обновл...»

2021-12-20T05:24:33Z

Новая страница: «Создает новое задание автоматического обновления для указанного ActiveGate. Задание обновл...»

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

Создает новое задание автоматического обновления для указанного ActiveGate.

Задание обновляет ActiveGate до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий 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.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

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

=== Объекты тела запроса ===

==== объект <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>{
"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>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|Обновить задание
|Успех. Обновление-задание создано.
|-
|400
|Конверт ошибки
|Не удалось. Введены неверные данные.
|}

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

==== объект <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>{
"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>

== Проверить полезную нагрузку ==
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

=== Ответ ===

==== Коды ответов ====
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
| -
|Подтверждено. Отправленное задание на обновление действительно. У ответа нет тела.
|-
|400
|Конверт ошибки
|Не удалось. Введены неверные данные.
|}

== Пример ==
В этом примере запрос создает задание обновления для обновления ActiveGate с идентификатором 1812885988 до версии 1.198.0.20200630-163221 .

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

==== Завиток ====
<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"targetVersion": "1.198.0.20200630-163221"
}'</code>

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

==== Тело запроса ====
<code>{
"targetVersion": "1.198.0.20200630-163221"
}</code>

==== Тело ответа ====
<code>{
"jobId": "-7240069678607892845",
"jobState": "PENDING",
"updateMethod": null,
"updateType": null,
"cancelable": true,
"startVersion": "1.195.5.20200522-174041",
"targetVersion": "1.198.0.20200630-163221",
"timestamp": null,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": null
}</code>

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