GET готовые работы*: различия между версиями

Текущая версия от 16:30, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Удалённое управление конфигурацией / АктивныйШлюз / GET готовые работы*

Перечисляет выполненные задания по настройке АктивныхШлюзов.

Запрос создает в качестве полезной нагрузки application/jsonформат.

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

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( activeGates.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
from	string	Начало запрошенного периода времени для задания удаленного управления конфигурацией. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы	query	по желанию
to	string	Конец запрошенного периода времени для задания удаленного управления конфигурацией. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы Если не установлено, используется текущая метка времени.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	RemoteConfigurationManagementJobList	Успех

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

Объект `RemoteConfigurationManagementJobList`

Список заданий удаленного управления конфигурацией.

Элемент	Тип	Описание
рабочие места	RemoteConfigurationManagementJobSummary[]	Список заданий удаленного управления конфигурацией.

Объект `RemoteConfigurationManagementJobSummary`

Задание удаленного управления конфигурацией с основными данными.

Элемент	Тип	Описание
entityType	string	Тип объектов, измененных удаленным управлением конфигурацией. Элемент может содержать эти значения `ACTIVE_GATE` `ONE_AGENT`
id	string	Идентификатор задания удаленного управления конфигурацией.
startTime	string	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
endTime	string	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.

JSON-модель тела ответа

<{
  "jobs": [
    {
      "entityType": "ACTIVE_GATE or ONE_AGENT",
      "id": "7974003406714390819",
      "startTime": "2020-11-05T08:15:30.144Z",
      "endTime": "2020-11-05T08:15:30.144Z"
    }
  ]
}

@@ Строка 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=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%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%A3%D0%B4%D0%B0%D0%BB%D1%91%D0%BD%D0%BD%D0%BE%D0%B5%20%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B5%D0%B9 Удалённое управление конфигурацией] / [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%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BF%D0%BE%20%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B5-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B9%D0%A8%D0%BB%D1%8E%D0%B7,-POST%20%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8 АктивныйШлюз] / GET готовые работы*'''''
 Перечисляет выполненные задания по настройке АктивныхШлюзов.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>
 |-
@@ Строка 118: / Строка 120: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "jobs": [
       {
@@ Строка 127: / Строка 129: @@
       }
     ]
-  }</code>
+  }