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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает параметры указанного задания автоматического обновления ActiveGate. Запрос создае...»)
 
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
Получает параметры указанного задания автоматического обновления ActiveGate.
Получает параметры указанного задания автоматического обновления АктивногоШлюза.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| 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>
|-
|-
|SaaS
|Среда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code>
|-
|Среда ActiveGate
|<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>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 26: Строка 23:
|-
|-
|стареть
|стареть
|нить
|string
|ID необходимого ActiveGate.
|ID необходимого АктивногоШлюза.
|дорожка
|дорожка
|по желанию
|по желанию
|-
|-
|jobId
|jobId
|нить
|string
|Уникальный идентификатор задания обновления ActiveGate.
|Уникальный идентификатор задания обновления АктивногоШлюза.
|дорожка
|дорожка
|по желанию
|по желанию
Строка 82: Строка 79:
|updateMethod
|updateMethod
|нить
|нить
|Метод обновления ActiveGate или его компонента.
|Метод обновления АктивногоШлюза или его компонента.


Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 105: Строка 102:
|agType
|agType
|нить
|нить
|Тип ActiveGate.
|Тип АктивногоШлюза.


Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 116: Строка 113:
|startVersion
|startVersion
|нить
|нить
|Первоначальная версия ActiveGate.
|Первоначальная версия АктивногоШлюза.
|по желанию
|по желанию
|-
|-
|окружающая среда
|окружающая среда
|строка []
|строка []
|Список сред (заданных идентификаторами), к которым ActiveGate может подключиться.
|Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
|по желанию
|по желанию
|-
|-
Строка 180: Строка 177:


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


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


==== Завиток ====
==== Curl ====
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684'</nowiki> \
  <code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684'</nowiki> \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

Текущая версия на 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 нить Статус задания обновления.

Элемент может содержать эти значения

  • FAILED
  • IN_PROGRESS
  • PENDING
  • ROLLBACK
  • SCHEDULED
  • SKIPPED
  • SUCCEED
 по желанию
updateMethod нить Метод обновления АктивногоШлюза или его компонента.

Элемент может содержать эти значения

  • AUTOMATIC
  • MANUAL_INSTALLATION
  • ON_DEMAND
 по желанию
updateType нить Компонент, который нужно обновить.

Элемент может содержать эти значения

  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE
 по желанию
agType нить Тип АктивногоШлюза.

Элемент может содержать эти значения

  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
 по желанию
startVersion нить Первоначальная версия АктивногоШлюза. по желанию
окружающая среда строка [] Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться. по желанию
отменяемый логический В настоящий момент задание можно ( 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"
}

Пример

В этом примере запрос перечисляет параметры задания автоматического обновления с идентификатором -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

Источник — https://doc.ruscomtech.ru/index.php?title=Получить_конкретное_задание_автообновления&oldid=3156