Просмотр кода страницы GET задание по настройке

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read OneAgents ( <code>oneAgents.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|id
|string
|Идентификатор требуемого задания удаленного управления конфигурацией.
|path
|требуется
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|RemoteConfigurationManagementJob
|Успех
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}

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

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

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

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

==== Объект <code>RemoteConfigurationManagementOperation</code> ====
Определение одной операции удаленного управления конфигурацией.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|attribute
|string
|Атрибут, на который влияет операция.

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

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

=== JSON-модель тела ответа ===
 <code>{
   "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"
 }</code>