GET задание по настройке

Материал из Документация Ключ-АСТРОМ
Версия от 15:13, 18 октября 2022; ENetrebin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает параметры задания конфигурации для ЕдиныхАгентов.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор требуемого задания удаленного управления конфигурацией. path требуется

Ответ

Коды ответов

Код Тип Описание
200 RemoteConfigurationManagementJob Успех
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект RemoteConfigurationManagementJob

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

Элемент Тип Описание
timeoutTime string Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.SSS'Z'), когда истечет время ожидания запущенного задания удаленного управления конфигурацией. Это поле присутствует только для запущенных заданий.
processedEntitiesCount integer Количество объектов, которые уже были обработаны на момент создания ответа.
totalEntitiesCount integer Общее количество объектов для обработки.
operations RemoteConfigurationManagementOperation[] Список выполненных заданий удаленного управления конфигурацией.
entityType string Тип объектов, измененных удаленным управлением конфигурацией.

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

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

Объект RemoteConfigurationManagementOperation

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

Элемент Тип Описание
attribute string Атрибут, на который влияет операция.

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

value string Значение, которое должно быть присвоено данному атрибуту.
operation string Операция, выполняемая над данным атрибутом.

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

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

{
  "timeoutTime": "2020-11-05T08:15:30.144Z",
  "processedEntitiesCount": 1,
  "totalEntitiesCount": 1,
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entityType": "ACTIVE_GATE or ONE_AGENT",
  "id": "7974003406714390819",
  "startTime": "2020-11-05T08:15:30.144Z",
  "endTime": "2020-11-05T08:15:30.144Z"
}