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

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

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

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

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

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

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

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

Параметры

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

Ответ

Коды ответов

Код	Тип	Описание
200	Обновить задание	Успех
404	Конверт ошибки	Не найден. См. Подробности в теле ответа.

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

объект `UpdateJob`

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

Элемент	Тип	Описание	необходимость
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"
}

Пример

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

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

Curl

<curl -L -X GET 'https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684

Тело ответа

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

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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|АктивныеШлюзы]] / Задания автообновлений / GET конкретное задание автообновления'''''
+'''''[[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 Задания автообновлений] / GET конкретное задание автообновления'''''
 Получает параметры указанного задания автоматического обновления АктивногоШлюза.
@@ Строка 6: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>
 |-
@@ Строка 144: / Строка 144: @@
 |}
 ===Модель JSON тела ответа===
-  <code>{
+  <{
     "jobState": "SUCCEED",
     "updateMethod": "AUTOMATIC",
@@ Строка 159: / Строка 159: @@
     "targetVersion": "1.190.0.20200301-130000",
     "error": "string"
-  }</code>
+  }
 ==Пример==
 В этом примере запрос перечисляет параметры задания автоматического обновления с идентификатором -7537034309286328684 от АктивногоШлюза с идентификатором 2131628184 .
@@ Строка 165: / Строка 165: @@
 Токен API передается в заголовке авторизации .
 ====Curl====
-  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684'</nowiki> \
+  <curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684'</nowiki> \
-  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ====URL запроса====
-  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "jobId": "-7537034309286328684",
     "jobState": "SUCCEED",
@@ Строка 185: / Строка 185: @@
     "error": null,
     "duration": 596047
-  }</code>
+  }
 ====Код ответа====