ENetrebin (обсуждение | вклад) (Новая страница: «Перечисляет все задания обновления для указанного ActiveGate. Список включает завершенные з...») |
Нет описания правки |
||
(не показана 1 промежуточная версия 1 участника) | |||
Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |ПОЛУЧИТЬ | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code> | ||
|- | |- | ||
|Среда АктивногоШлюза | |||
|Среда | |||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение | Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов( <code>activeGates.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
Строка 27: | Строка 24: | ||
|стареть | |стареть | ||
|нить | |нить | ||
|ID необходимого | |ID необходимого АктивногоШлюза. | ||
|дорожка | |дорожка | ||
|по желанию | |по желанию | ||
Строка 223: | Строка 220: | ||
|agType | |agType | ||
|нить | |нить | ||
|Тип | |Тип АктивногоШлюза. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
Строка 234: | Строка 231: | ||
|startVersion | |startVersion | ||
|нить | |нить | ||
|Первоначальная версия | |Первоначальная версия АктивногоШлюза. | ||
|по желанию | |по желанию | ||
|- | |- | ||
|окружающая среда | |окружающая среда | ||
|строка [] | |строка [] | ||
|Список сред (заданных идентификаторами), к которым | |Список сред (заданных идентификаторами), к которым АктивногоШлюза может подключиться. | ||
|по желанию | |по желанию | ||
|- | |- | ||
Строка 280: | Строка 277: | ||
=== Модель JSON тела ответа === | === Модель JSON тела ответа === | ||
< | <{ | ||
"agId": "0x3efdd092", | "agId": "0x3efdd092", | ||
"updateJobs": [ | "updateJobs": [ | ||
Строка 308: | Строка 305: | ||
==== Завиток ==== | ==== Завиток ==== | ||
< | <curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs'</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
Строка 315: | Строка 312: | ||
==== Тело ответа ==== | ==== Тело ответа ==== | ||
< | <{ | ||
"agId": "2100855201", | "agId": "2100855201", | ||
"updateJobs": [ | "updateJobs": [ |
Текущая версия от 09:33, 26 декабря 2024
Перечисляет все задания обновления для указанного ActiveGate. Список включает завершенные задания (успешные или неудачные) и незавершенные.
Запрос создает application/json
полезную нагрузку.
ПОЛУЧИТЬ | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение АктивныхШлюзов( activeGates.read
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
Параметр | Тип | Описание | В | необходимые |
---|---|---|---|---|
стареть | нить | ID необходимого АктивногоШлюза. | дорожка | по желанию |
от | нить | Начало запрошенного периода времени для обновлений.
Вы можете использовать один из следующих форматов:
Если не установлен, используется относительный таймфрейм в одну неделю ( Максимальный срок - 31 день. |
запрос | обязательный |
к | нить | Конец запрошенного периода для обновлений.
Вы можете использовать один из следующих форматов:
Если не установлен, используется текущая отметка времени. |
запрос | обязательный |
startVersionCompareType | нить | Фильтрует полученный набор заданий обновления по указанной начальной версии.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
запрос | обязательный |
startVersion | нить | Фильтрует полученный набор обновлений по исходной версии (требуемый формат <major>.<minor>.<revision> ).
|
запрос | обязательный |
updateType | нить | Фильтрует результирующий набор обновлений по типу обновления.
Элемент может содержать эти значения
|
запрос | обязательный |
targetVersionCompareType | нить | Фильтрует полученный набор заданий обновления по указанной целевой версии.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
запрос | обязательный |
targetVersion | нить | Фильтрует результирующий набор обновлений по целевой версии (требуемый формат <major>.<minor>.<revision> ).
|
запрос | обязательный |
lastUpdates | логический | Если true , фильтрует результирующий набор заданий обновления до самых последних обновлений каждого типа.
|
запрос | обязательный |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Обновить список вакансий | Успех |
404 | Конверт ошибки | Не найден. См. Подробности в теле ответа. |
Объекты тела ответа
объект UpdateJobList
Список обновлений ActiveGate.
Элемент | Тип | Описание | необходимые |
---|---|---|---|
стареть | нить | Идентификатор ActiveGate. | по желанию |
updateJobs | Обновить задание [] | Список обновлений ActiveGate. | по желанию |
объект UpdateJob
Конфигурация задания обновления ActiveGate.
Элемент | Тип | Описание | необходимые |
---|---|---|---|
jobState | нить | Статус задания обновления.
Элемент может содержать эти значения
|
по желанию |
updateMethod | нить | Метод обновления ActiveGate или его компонента.
Элемент может содержать эти значения
|
по желанию |
updateType | нить | Компонент, который нужно обновить.
Элемент может содержать эти значения
|
по желанию |
agType | нить | Тип АктивногоШлюза.
Элемент может содержать эти значения
|
по желанию |
startVersion | нить | Первоначальная версия АктивногоШлюза. | по желанию |
окружающая среда | строка [] | Список сред (заданных идентификаторами), к которым АктивногоШлюза может подключиться. | по желанию |
отменяемый | логический | В настоящий момент задание можно ( true ) или нельзя ( false ) отменить.
|
по желанию |
jobId | нить | Идентификатор задания обновления. | по желанию |
отметка времени | целое число | Отметка времени завершения задания обновления.
|
по желанию |
продолжительность | целое число | Продолжительность обновления в миллисекундах. | по желанию |
targetVersion | нить | Целевая версия обновления.
Укажите версию в Чтобы обновить до последней доступной версии, используйте |
обязательный |
ошибка | нить | Информация об ошибке обновления. | по желанию |
Модель JSON тела ответа
<{ "agId": "0x3efdd092", "updateJobs": [ { "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" } ] }
Пример
В этом примере в запросе перечислены все задания автоматического обновления ActiveGate с идентификатором 2100855201 .
Токен API передается в заголовке авторизации .
Завиток
<curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs' \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL запроса
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs
Тело ответа
<{ "agId": "2100855201", "updateJobs": [ { "jobId": "-3137933319273211278", "jobState": "SUCCEED", "updateMethod": "MANUAL_INSTALLATION", "updateType": "ACTIVE_GATE", "cancelable": false, "startVersion": "1.198.0.20200629-221007", "targetVersion": "1.198.0.20200630-163221", "timestamp": 1593683526719, "agType": "ENVIRONMENT", "environments": [ "mySampleEnv" ], "error": null, "duration": 556574 }, { "jobId": "-6733215466838702651", "jobState": "SUCCEED", "updateMethod": "AUTOMATIC", "updateType": "REMOTE_PLUGIN_AGENT", "cancelable": false, "startVersion": "1.198.0.20200629-123323", "targetVersion": "1.198.0.20200630-155408", "timestamp": 1593545522797, "agType": "ENVIRONMENT", "environments": [ "mySampleEnv" ], "error": null, "duration": 42669 } ] }
Код ответа
200