API АппОптима / Эндпойнты среды / Развёртывание / Удалённое управление конфигурацией / ЕдиныйАгент / POST задание конфигурации
Запрос потребляет application/jsonполезную нагрузку.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write OneAgents ( oneAgents.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Вы идентифицируете своих ЕдиныхАгентов по их идентификаторам. Используйте ЕдиныйАгент в запросе хоста, чтобы узнать идентификаторы ЕдиногоАгента, которые вы хотите настроить.
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| restart | boolean | Если установлено значение false, ЕдиныеАгенты не будет перезапущен после применения конфигурации.
|
query | по желанию |
| body | RemoteConfigurationManagementOperationOneAgentRequest | Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией. | body | требуется |
Объекты тела запроса
Объект RemoteConfigurationManagementOperationOneAgentRequest
Запрос на создание операции удаленного управления конфигурацией.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| operations | RemoteConfigurationManagementOperation[] | Список операций удаленного управления конфигурацией, которые необходимо выполнить. | требуется |
| entities | string [] | Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией. | требуется |
Объект RemoteConfigurationManagementOperation
Определение одной операции удаленного управления конфигурацией.
| Элемент | Тип | Описание | Необходимый |
|---|---|---|---|
| attribute | string | Атрибут, на который влияет операция.
Элемент может содержать эти значения
|
требуется |
| value | string | Значение, которое должно быть присвоено данному атрибуту. | по желанию |
| operation | string | Операция, выполняемая над данным атрибутом.
Элемент может содержать эти значения
|
требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"operations": [
{
"attribute": "networkZone",
"value": "exampleNetworkZoneName",
"operation": "set"
}
],
"entities": [
"HOST-D454A967666E7970",
"HOST-811760CFF2A5E872"
]
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 201 | RemoteConfigurationManagementJob | Созданный |
| 400 | RemoteConfigurationManagementValidationResult | Не удалось. Ввод недействителен. |
| 409 | В настоящее время выполняется другое задание удаленного управления конфигурацией. |
Объекты тела ответа
Объект RemoteConfigurationManagementJob
Задание удаленного управления конфигурацией.
| Элемент | Тип | Описание |
|---|---|---|
| timeoutTime | string | Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.SSS'Z'), когда истечет время ожидания запущенного задания удаленного управления конфигурацией. Это поле присутствует только для запущенных заданий. |
| processedEntitiesCount | integer | Количество объектов, которые уже были обработаны на момент создания ответа. |
| totalEntitiesCount | integer | Общее количество объектов для обработки. |
| operations | RemoteConfigurationManagementOperation[] | Список выполненных заданий удаленного управления конфигурацией. |
| entityType | string | Тип объектов, измененных удаленным управлением конфигурацией.
Элемент может содержать эти значения |
| 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"
}
Ответ не отправляется клиенту до тех пор, пока не будут обработаны все ЕдиныеАгенты, определенные в полезной нагрузке. ЕдиныйАгент считается обработанным, когда ему отправляется сообщение о реконфигурации; фактическая реконфигурация выполняется независимо от ЕдиногоАгента.
Проверка полезную нагрузку
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос потребляет application/jsonполезную нагрузку.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/validator
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/validator
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write OneAgents ( oneAgents.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Успех. Ответ не имеет тела. | |
| 400 | RemoteConfigurationManagementValidationResult | Не удалось. Ввод недействителен. |