GET задание по настройке: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает параметры задания конфигурации для OneAgents. Запрос создает <code>application/json</code>полез...»)
 
 
Строка 1: Строка 1:
Получает параметры задания конфигурации для OneAgents.
Получает параметры задания конфигурации для ЕдиныхАгентов.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="2" |GET
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}</nowiki></code>
|-
|-
|SaaS
|Среда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/{id}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-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>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read OneAgents ( <code>oneAgents.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 22: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|я бы
|id
|нить
|string
|Идентификатор требуемого задания удаленного управления конфигурацией.
|Идентификатор требуемого задания удаленного управления конфигурацией.
|дорожка
|path
|требуется
|требуется
|}
|}
Строка 41: Строка 38:
|-
|-
|200
|200
|Задание удаленного управления конфигурацией
|RemoteConfigurationManagementJob
|Успех
|Успех
|-
|-
Строка 51: Строка 48:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


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


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


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


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


Текущая версия на 15:13, 18 октября 2022

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

Запрос создает 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"
}
Источник — https://doc.ruscomtech.ru/index.php?title=GET_задание_по_настройке&oldid=1786