Вы можете создать предварительный просмотр перед выполнением фактического изменения конфигурации.
Предварительный просмотр говорит вам:
- Сколько объектов в настоящее время настроено, как описано в полезной нагрузке
- Сколько объектов будет настроено таким образом при отправке запроса на реконфигурацию
Запрос потребляет application/jsonполезную нагрузку.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write OneAgents ( oneAgents.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | RemoteConfigurationManagementOperationOneAgentRequest | Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией. | body | требуется |
Объекты тела запроса
Объект RemoteConfigurationManagementOperationOneAgentRequest
Запрос на создание операции удаленного управления конфигурацией.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| operations | RemoteConfigurationManagementOperation[] | Список операций удаленного управления конфигурацией, которые необходимо выполнить. | требуется |
| entities | string[] | Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией. | требуется |
Объект RemoteConfigurationManagementOperation
Определение одной операции удаленного управления конфигурацией.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| attribute | нить | Атрибут, на который влияет операция.
Элемент может содержать эти значения
|
требуется |
| value | нить | Значение, которое должно быть присвоено данному атрибуту. | по желанию |
| operation | нить | Операция, выполняемая над данным атрибутом.
Элемент может содержать эти значения
|
требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"operations": [
{
"attribute": "networkZone",
"value": "exampleNetworkZoneName",
"operation": "set"
}
],
"entities": [
"HOST-D454A967666E7970",
"HOST-811760CFF2A5E872"
]
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | RemoteConfigurationManagementPreviewList | Успех |
| 400 | RemoteConfigurationManagementValidationResult | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект RemoteConfigurationManagementPreviewList
Список предварительных просмотров заданий удаленного управления конфигурацией.
| Элемент | Тип | Описание |
|---|---|---|
| previews | RemoteConfigurationManagementJobPreview[] | Список предварительных просмотров заданий удаленного управления конфигурацией. |
Объект RemoteConfigurationManagementJobPreview
Предварительный просмотр задания удаленного управления конфигурацией.
| Элемент | Тип | Описание |
|---|---|---|
| alreadyConfiguredEntitiesCount | integer | Количество объектов, которые в настоящее время настроены в соответствии с операцией удаленного управления конфигурацией. |
| targetEntitiesCount | integer | Количество объектов, которые будут настроены в соответствии с определением удаленного управления конфигурацией после его завершения. |
| attribute | string | Атрибут, на который влияет операция.
Элемент может содержать эти значения
|
| value | string | Значение, которое должно быть присвоено данному атрибуту. |
| operation | string | Операция, выполняемая над данным атрибутом.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"previews": [
{
"alreadyConfiguredEntitiesCount": 1,
"targetEntitiesCount": 2,
"attribute": "networkZone",
"value": "exampleNetworkZoneName",
"operation": "set"
}
]
}