GET текущая работа: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: « Вы можете создать предварительный просмотр перед выполнением фактического изменения...»)
 
 
Строка 1: Строка 1:
Получает параметры текущего задания конфигурации для ЕдиныхАгентов.


 
Запрос создает <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/preview</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/current</nowiki></code>
|-
|-
|SaaS
|Среда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/preview</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/current</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Запрос не предоставляет никаких настраиваемых параметров.
== Ответ ==
=== Коды ответов ===
{| class="wikitable"
{| class="wikitable"
!Параметр
!Код
!Тип
|Тип
!Описание
!Описание
!В
!Необходимый
|-
|-
|тело
|200
|Операция удаленного управления конфигурацией Один запрос агента
|RemoteConfigurationManagementJob
|Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.
|Успех
|тело
|-
|требуется
|204
|
|В настоящее время не выполняется ни одно задание удаленного управления конфигурацией.
|}
|}


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


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


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


* <code>clear</code>
* <code>ACTIVE_GATE</code>
* <code>set</code>
* <code>ONE_AGENT</code>
|требуется
|}
 
=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entities": [
    "HOST-D454A967666E7970",
    "HOST-811760CFF2A5E872"
  ]
}</code>
 
== Ответ ==
 
=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|-
|200
|id
|Предварительный список удаленного управления конфигурацией
|string
|Успех
|Идентификатор задания удаленного управления конфигурацией.
|-
|-
|400
|startTime
|RemoteConfigurationManagementValidationResult
|string
|Не удалось. Ввод недействителен.
|Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
|}
 
=== Объекты тела ответа ===
 
==== Объект _ <code>RemoteConfigurationManagementPreviewList</code> ====
Список предварительных просмотров заданий удаленного управления конфигурацией.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|-
|превью
|endTime
|Предварительный просмотр задания удаленного управления конфигурацией []
|string
|Список предварительных просмотров заданий удаленного управления конфигурацией.
|Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.
|}
|}


==== Объект _ <code>RemoteConfigurationManagementJobPreview</code> ====
==== Объект <code>RemoteConfigurationManagementOperation</code> ====
Предварительный просмотр задания удаленного управления конфигурацией.
Определение одной операции удаленного управления конфигурацией.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 149: Строка 88:
!Описание
!Описание
|-
|-
|уже сконфигурированный EntitiesCount
|attribute
|целое число
|string
|Количество объектов, которые в настоящее время настроены в соответствии с операцией удаленного управления конфигурацией.
|-
|targetEntitiesCount
|целое число
|Количество объектов, которые будут настроены в соответствии с определением удаленного управления конфигурацией после его завершения.
|-
|атрибут
|нить
|Атрибут, на который влияет операция.
|Атрибут, на который влияет операция.


Строка 167: Строка 98:
* <code>networkZone</code>
* <code>networkZone</code>
|-
|-
|ценность
|value
|нить
|string
|Значение, которое должно быть присвоено данному атрибуту.
|Значение, которое должно быть присвоено данному атрибуту.
|-
|-
|операция
|operation
|нить
|string
|Операция, выполняемая над данным атрибутом.
|Операция, выполняемая над данным атрибутом.


Строка 183: Строка 114:
=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <code>{
   "previews": [
   "timeoutTime": "2020-11-05T08:15:30.144Z",
  "processedEntitiesCount": 1,
  "totalEntitiesCount": 1,
  "operations": [
     {
     {
      "alreadyConfiguredEntitiesCount": 1,
      "targetEntitiesCount": 2,
       "attribute": "networkZone",
       "attribute": "networkZone",
       "value": "exampleNetworkZoneName",
       "value": "exampleNetworkZoneName",
       "operation": "set"
       "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>
  }</code>

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

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

Запрос создает application/jsonполезную нагрузку.

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

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 RemoteConfigurationManagementJob Успех
204 В настоящее время не выполняется ни одно задание удаленного управления конфигурацией.

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

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

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

  • 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"
}
Источник — https://doc.ruscomtech.ru/index.php?title=GET_текущая_работа&oldid=1784