Получить конкретное задание автообновления: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | 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> | ||
|- | |- | ||
|Среда АктивногоШлюза | |||
|Среда | |||
|<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> | ||
|} | |} | ||
| Строка 33: | Строка 30: | ||
|jobId | |jobId | ||
|string | |string | ||
|Уникальный идентификатор задания обновления | |Уникальный идентификатор задания обновления АктивногоШлюза. | ||
|дорожка | |дорожка | ||
|по желанию | |по желанию | ||
| Строка 82: | Строка 79: | ||
|updateMethod | |updateMethod | ||
|нить | |нить | ||
|Метод обновления | |Метод обновления АктивногоШлюза или его компонента. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| Строка 105: | Строка 102: | ||
|agType | |agType | ||
|нить | |нить | ||
|Тип | |Тип АктивногоШлюза. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
| Строка 116: | Строка 113: | ||
|startVersion | |startVersion | ||
|нить | |нить | ||
|Первоначальная версия | |Первоначальная версия АктивногоШлюза. | ||
|по желанию | |по желанию | ||
|- | |- | ||
|окружающая среда | |окружающая среда | ||
|строка [] | |строка [] | ||
|Список сред (заданных идентификаторами), к которым | |Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться. | ||
|по желанию | |по желанию | ||
|- | |- | ||
Текущая версия на 17:56, 21 сентября 2023
Получает параметры указанного задания автоматического обновления АктивногоШлюза.
Запрос создает application/jsonполезную нагрузку.
| ПОЛУЧИТЬ | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов ( activeGates.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | необходимые |
|---|---|---|---|---|
| стареть | string | ID необходимого АктивногоШлюза. | дорожка | по желанию |
| jobId | string | Уникальный идентификатор задания обновления АктивногоШлюза. | дорожка | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Обновить задание | Успех |
| 404 | Конверт ошибки | Не найден. См. Подробности в теле ответа. |
Объекты тела ответа
объект UpdateJob
Конфигурация задания обновления ActiveGate.
| Элемент | Тип | Описание | необходимые |
|---|---|---|---|
| jobState | нить | Статус задания обновления.
Элемент может содержать эти значения
|
по желанию |
| updateMethod | нить | Метод обновления АктивногоШлюза или его компонента.
Элемент может содержать эти значения
|
по желанию |
| updateType | нить | Компонент, который нужно обновить.
Элемент может содержать эти значения
|
по желанию |
| agType | нить | Тип АктивногоШлюза.
Элемент может содержать эти значения
|
по желанию |
| startVersion | нить | Первоначальная версия АктивногоШлюза. | по желанию |
| окружающая среда | строка [] | Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться. | по желанию |
| отменяемый | логический | В настоящий момент задание можно ( true) или нельзя ( false) отменить.
|
по желанию |
| jobId | нить | Идентификатор задания обновления. | по желанию |
| отметка времени | целое число | Отметка времени завершения задания обновления.
|
по желанию |
| продолжительность | целое число | Продолжительность обновления в миллисекундах. | по желанию |
| targetVersion | нить | Целевая версия обновления.
Укажите версию в Чтобы обновить до последней доступной версии, используйте |
обязательный |
| ошибка | нить | Информация об ошибке обновления. | по желанию |
Модель 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.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL запроса
https://mySampleEnv.live.dynatrace.com/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
