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

Текущая версия от 14:10, 24 декабря 2024

API АппОптима / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / POST задание автообновления

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

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

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

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs`
POST	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs`

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

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

Параметры

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

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

объект `UpdateJob`

Конфигурация задания обновления АктивногоШлюза.

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

Модель 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`

Конфигурация задания обновления АктивногоШлюза.

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

Модель 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полезную нагрузку.

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator`
POST	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator`

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

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

Ответ

Коды ответов

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

Пример

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

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

Curl

<curl -L -X POST 'https://mySampleEnv.live.AppOptima.ru/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.AppOptima.ru/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

@@ Строка 1: / Строка 1: @@
+'''''[[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 Задания автообновлений] / POST задание автообновления'''''
 Создает новое задание автоматического обновления для указанного АктивногоШлюза.
@@ Строка 6: / Строка 8: @@
 {| class="wikitable"
 | rowspan="2" |POST
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
 |-
@@ Строка 130: / Строка 132: @@
 ===Модель JSON тела запроса===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "jobState": "SUCCEED",
     "updateMethod": "AUTOMATIC",
@@ Строка 145: / Строка 147: @@
     "targetVersion": "1.190.0.20200301-130000",
     "error": "string"
-  }</code>
+  }
 ==Ответ==
 ===Коды ответов===
@@ Строка 256: / Строка 258: @@
 |}
 ===Модель JSON тела ответа===
-  <code>{
+  <{
     "jobState": "SUCCEED",
     "updateMethod": "AUTOMATIC",
@@ Строка 271: / Строка 273: @@
     "targetVersion": "1.190.0.20200301-130000",
     "error": "string"
-  }</code>
+  }
 ==Проверить полезную нагрузку==
 Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
@@ Строка 278: / Строка 280: @@
 {| class="wikitable"
 | rowspan="2" |POST
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
 |-
@@ Строка 306: / Строка 308: @@
 Токен API передается в заголовке авторизации .
 ====Curl====
-  <code>curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \
+  <curl -L -X POST '<nowiki>https://mySampleEnv.live.AppOptima.ru/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.ruscomtech.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
 ====Тело запроса====
-  <code>{
+  <{
     "targetVersion": "1.198.0.20200630-163221"
-  }</code>
+  }
 ====Тело ответа====
-  <code>{
+  <{
     "jobId": "-7240069678607892845",
     "jobState": "PENDING",
@@ Строка 334: / Строка 336: @@
     "error": null,
     "duration": null
-  }</code>
+  }
 ====Код ответа====

Текущая версия от 14:10, 24 декабря 2024

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

Параметры

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

объект UpdateJob

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

Ответ

Коды ответов

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

объект UpdateJob

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

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

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

Ответ

Коды ответов

Пример

Curl

URL запроса

Тело запроса

Тело ответа

Код ответа

объект `UpdateJob`

объект `UpdateJob`