Разместить задание автообновления: различия между версиями

Версия от 07:53, 18 февраля 2022

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

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

Запрос потребляет и производит application/jsonполезную нагрузку.

ПОЧТА	Удалось	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs`
	Среда ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs`

Аутентификация

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

Параметры

Параметр	Тип	Описание	В	необходимые
стареть	нить	ID необходимого ActiveGate.	дорожка	по желанию
тело	Обновить задание	Тело запроса в формате JSON, содержащее параметры задания обновления.	тело	обязательный

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

объект `UpdateJob`

Конфигурация задания обновления ActiveGate.

Элемент	Тип	Описание	необходимые
jobState	нить	Статус задания обновления. Элемент может содержать эти значения `FAILED` `IN_PROGRESS` `PENDING` `ROLLBACK` `SCHEDULED` `SKIPPED` `SUCCEED`	по желанию
updateMethod	нить	Метод обновления ActiveGate или его компонента. Элемент может содержать эти значения `AUTOMATIC` `MANUAL_INSTALLATION` `ON_DEMAND`	по желанию
updateType	нить	Компонент, который нужно обновить. Элемент может содержать эти значения `ACTIVE_GATE` `REMOTE_PLUGIN_AGENT` `SYNTHETIC` `Z_REMOTE`	по желанию
agType	нить	Тип ActiveGate. Элемент может содержать эти значения `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`	по желанию
startVersion	нить	Первоначальная версия ActiveGate.	по желанию
окружающая среда	строка []	Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.	по желанию
отменяемый	логический	В настоящий момент задание можно ( `true`) или нельзя ( `false`) отменить.	по желанию
jobId	нить	Идентификатор задания обновления.	по желанию
отметка времени	целое число	Отметка времени завершения задания обновления. `null`Значение означает , что работа по - прежнему работает.	по желанию
продолжительность	целое число	Продолжительность обновления в миллисекундах.	по желанию
targetVersion	нить	Целевая версия обновления. Укажите версию в `<major>.<minor>.<revision>.<timestamp>`формате. Чтобы обновить до последней доступной версии, используйте `latest`значение.	обязательный
ошибка	нить	Информация об ошибке обновления.	по желанию

Модель JSON тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "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"
}

Ответ

Коды ответов

Код	Тип	Описание
201	Обновить задание	Успех. Обновление-задание создано.
400	Конверт ошибки	Не удалось. Введены неверные данные.

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

объект `UpdateJob`

Конфигурация задания обновления ActiveGate.

Элемент	Тип	Описание	необходимые
jobState	нить	Статус задания обновления. Элемент может содержать эти значения `FAILED` `IN_PROGRESS` `PENDING` `ROLLBACK` `SCHEDULED` `SKIPPED` `SUCCEED`	по желанию
updateMethod	нить	Метод обновления ActiveGate или его компонента. Элемент может содержать эти значения `AUTOMATIC` `MANUAL_INSTALLATION` `ON_DEMAND`	по желанию
updateType	нить	Компонент, который нужно обновить. Элемент может содержать эти значения `ACTIVE_GATE` `REMOTE_PLUGIN_AGENT` `SYNTHETIC` `Z_REMOTE`	по желанию
agType	нить	Тип ActiveGate. Элемент может содержать эти значения `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`	по желанию
startVersion	нить	Первоначальная версия ActiveGate.	по желанию
окружающая среда	строка []	Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.	по желанию
отменяемый	логический	В настоящий момент задание можно ( `true`) или нельзя ( `false`) отменить.	по желанию
jobId	нить	Идентификатор задания обновления.	по желанию
отметка времени	целое число	Отметка времени завершения задания обновления. `null`Значение означает , что работа по - прежнему работает.	по желанию
продолжительность	целое число	Продолжительность обновления в миллисекундах.	по желанию
targetVersion	нить	Целевая версия обновления. Укажите версию в `<major>.<minor>.<revision>.<timestamp>`формате. Чтобы обновить до последней доступной версии, используйте `latest`значение.	обязательный
ошибка	нить	Информация об ошибке обновления.	по желанию

Модель JSON тела ответа

{
  "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"
}

Проверить полезную нагрузку

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

Запрос потребляет application/jsonполезную нагрузку.

ПОЧТА	Удалось	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/validator`
	Среда ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator`

Аутентификация

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

Ответ

Коды ответов

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

Пример

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

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

Завиток

curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
    "targetVersion": "1.198.0.20200630-163221"
}'

URL запроса

https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs

Тело запроса

{
  "targetVersion": "1.198.0.20200630-163221"
}

Тело ответа

{
  "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
}

Код ответа

201

Версия от 05:24, 20 декабря 2021 (просмотреть исходный код) ENetrebin (обсуждение \| вклад) (Новая страница: «Создает новое задание автоматического обновления для указанного ActiveGate. Задание обновл...») Метка: через визуальный редактор		Версия от 07:53, 18 февраля 2022 (просмотреть исходный код) ENetrebin (обсуждение \| вклад) Нет описания правки Метка: через визуальный редактор Следующая правка →
Строка 1:		Строка 1:
	Создает новое задание автоматического обновления для указанного ActiveGate.		Создает новое задание автоматического обновления для указанного ActiveGate.

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

Версия от 07:53, 18 февраля 2022

Аутентификация

Параметры

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

объект UpdateJob

Модель JSON тела запроса

Ответ

Коды ответов

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

объект UpdateJob

Модель JSON тела ответа

Проверить полезную нагрузку

Аутентификация

Ответ

Коды ответов

Пример

Завиток

URL запроса

Тело запроса

Тело ответа

Код ответа

объект `UpdateJob`

объект `UpdateJob`