POST задание конфигурации*

Материал из Документация Ключ-АСТРОМ

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

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

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

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

Параметры

Вы идентифицируете свои АктивныеШлюзы по их идентификаторам. Используйте запрос GET all ActiveGate , чтобы узнать идентификаторы АктивногоШлюза, которые вы хотите настроить.

Параметр Тип Описание In Необходимость
body RemoteConfigurationManagementOperationActiveGateRequest Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией. body требуется

Объекты тела запроса

Объект RemoteConfigurationManagementOperationActiveGateRequest

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

Элемент Тип Описание Необходимость
operations RemoteConfigurationManagementOperation[] Список операций удаленного управления конфигурацией, которые необходимо выполнить. требуется
entities string[] Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией. требуется

Объект RemoteConfigurationManagementOperation

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

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

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

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

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

  • clear
  • set
 требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

{
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entities": [
    "0x2b7c0b02",
    "0x4928065d"
  ]
}

Ответ

Ответ не отправляется клиенту до тех пор, пока все АктивныеШлюзы, определенные в полезной нагрузке, не будут обработаны. АктивныйШлюз считается обработанным, когда ему отправляется сообщение о реконфигурации; фактическая реконфигурация обрабатывается от АктивногоШлюза независимо.

Коды ответов

Код Тип Описание
201 RemoteConfigurationManagementJob Создание
400 RemoteConfigurationManagementValidationResult Не удалось. Ввод недействителен.
409 В настоящее время выполняется другое задание удаленного управления конфигурацией.

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

Объект RemoteConfigurationManagementJob

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

Element Type Описание
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 Атрибут, на который влияет операция.

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

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

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

  • clear
  • set

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"
}

Проверить полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

Ответ

Коды ответов

Код Тип Описание
204 Успех. Ответ не имеет тела.
400 RemoteConfigurationManagementValidationResult Не удалось. Ввод недействителен.
Источник — https://doc.ruscomtech.ru/index.php?title=POST_задание_конфигурации*&oldid=1787