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

ENetrebin в 17:56, 21 сентября 2023

2023-09-21T17:56:33Z

← Предыдущая		Версия 17:56, 21 сентября 2023
Строка 7:		Строка 7:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>
	\|-		\|-
	\|Среда ~~ActiveGate~~		\|Среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>
	\|}		\|}
Строка 30:		Строка 30:
	\|jobId		\|jobId
	\|string		\|string
	\|Уникальный идентификатор задания обновления ~~ActiveGate~~.		\|Уникальный идентификатор задания обновления АктивногоШлюза.
	\|дорожка		\|дорожка
	\|по желанию		\|по желанию
Строка 79:		Строка 79:
	\|updateMethod		\|updateMethod
	\|нить		\|нить
	\|Метод обновления ~~ActiveGate~~ или его компонента.		\|Метод обновления АктивногоШлюза или его компонента.

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

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

ENetrebin в 17:54, 21 сентября 2023

2023-09-21T17:54:53Z

← Предыдущая		Версия 17:54, 21 сентября 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/{jobId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>
	\|-
	~~\|SaaS~~
	~~\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>~~
	\|-		\|-
	\|Среда ActiveGate		\|Среда ActiveGate

ENetrebin: /* Завиток */

2022-10-06T17:32:42Z

Завиток

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

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
Строка 15:		Строка 15:

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

	== Параметры ==		== Параметры ==
Строка 26:		Строка 26:
	\|-		\|-
	\|стареть		\|стареть
	\|~~нить~~		\|string
	\|ID необходимого ~~ActiveGate~~.		\|ID необходимого АктивногоШлюза.
	\|дорожка		\|дорожка
	\|по желанию		\|по желанию
	\|-		\|-
	\|jobId		\|jobId
	\|~~нить~~		\|string
	\|Уникальный идентификатор задания обновления ActiveGate.		\|Уникальный идентификатор задания обновления ActiveGate.
	\|дорожка		\|дорожка
Строка 180:		Строка 180:

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

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

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

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

2021-12-20T05:22:12Z

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

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

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

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

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

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

== Ответ ==

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

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

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

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

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

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

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

==== Тело ответа ====
<code>{
"jobId": "-7537034309286328684",
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "SYNTHETIC",
"cancelable": false,
"startVersion": "1.198.0.20200629-183024",
"targetVersion": "1.198.0.20200630-114457",
"timestamp": 1593518788274,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 596047
}</code>

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