POST предпросмотр работы: различия между версиями

Текущая версия от 16:26, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Удалённое управление конфигурацией / ЕдиныйАгент / POST предпросмотр работы

Вы можете создать предварительный просмотр перед выполнением фактического изменения конфигурации.

Предварительный просмотр говорит вам:

Сколько объектов в настоящее время настроено, как описано в полезной нагрузке
Сколько объектов будет настроено таким образом при отправке запроса на реконфигурацию

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

POST	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview`
POST	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	нить	Атрибут, на который влияет операция. Элемент может содержать эти значения `group` `hostGroup` `networkZone`	требуется
value	нить	Значение, которое должно быть присвоено данному атрибуту.	по желанию
operation	нить	Операция, выполняемая над данным атрибутом. Элемент может содержать эти значения `clear` `set`	требуется

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	Атрибут, на который влияет операция. Элемент может содержать эти значения `group` `hostGroup` `networkZone`
value	string	Значение, которое должно быть присвоено данному атрибуту.
operation	string	Операция, выполняемая над данным атрибутом. Элемент может содержать эти значения `clear` `set`

JSON-модель тела ответа

<{
  "previews": [
    {
      "alreadyConfiguredEntitiesCount": 1,
      "targetEntitiesCount": 2,
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ]
}

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A3%D0%B4%D0%B0%D0%BB%D1%91%D0%BD%D0%BD%D0%BE%D0%B5%20%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B5%D0%B9 Удалённое управление конфигурацией] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A3%D0%B4%D0%B0%D0%BB%D1%91%D0%BD%D0%BD%D0%BE%D0%B5%20%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B5%D0%B9-,%D0%95%D0%B4%D0%B8%D0%BD%D1%8B%D0%B9%D0%90%D0%B3%D0%B5%D0%BD%D1%82,-POST%20%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8 ЕдиныйАгент] / POST предпросмотр работы'''''
 Вы можете создать предварительный просмотр перед выполнением фактического изменения конфигурации.
@@ Строка 8: / Строка 10: @@
 Запрос потребляет <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-| rowspan="3" |ПОЧТА
+| rowspan="2" |POST
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/preview</nowiki></code>
 |-
-|SaaS
+|Cреда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/preview</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>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write OneAgents ( <code>oneAgents.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 27: / Строка 26: @@
 !Тип
 !Описание
-!В
+!In
-!Необходимый
+!Необходимость
 |-
-|тело
+|body
-|Операция удаленного управления конфигурацией Один запрос агента
+|RemoteConfigurationManagementOperationOneAgentRequest
 |Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.
-|тело
+|body
 |требуется
 |}
@@ Строка 39: / Строка 38: @@
 === Объекты тела запроса ===
-==== Объект _ <code>RemoteConfigurationManagementOperationOneAgentRequest</code> ====
+==== Объект <code>RemoteConfigurationManagementOperationOneAgentRequest</code> ====
 Запрос на создание операции удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 45: / Строка 44: @@
 !Тип
 !Описание
-!Необходимый
+!Необходимость
 |-
-|операции
+|operations
-|Операция удаленного управления конфигурацией []
+|RemoteConfigurationManagementOperation[]
 |Список операций удаленного управления конфигурацией, которые необходимо выполнить.
 |требуется
 |-
-|сущности
+|entities
-|строка []
+|string[]
-|Список идентификаторов сущностей, для которых должно выполняться удаленное управление конфигурацией.
+|Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией.
 |требуется
 |}
-==== Объект _ <code>RemoteConfigurationManagementOperation</code> ====
+==== Объект <code>RemoteConfigurationManagementOperation</code> ====
 Определение одной операции удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 64: / Строка 63: @@
 !Тип
 !Описание
-!Необходимый
+!Необходимость
 |-
-|атрибут
+|attribute
 |нить
 |Атрибут, на который влияет операция.
@@ Строка 77: / Строка 76: @@
 |требуется
 |-
-|ценность
+|value
 |нить
 |Значение, которое должно быть присвоено данному атрибуту.
 |по желанию
 |-
-|операция
+|operation
 |нить
 |Операция, выполняемая над данным атрибутом.
@@ Строка 95: / Строка 94: @@
 === JSON-модель тела запроса ===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "operations": [
       {
@@ Строка 107: / Строка 106: @@
       "HOST-811760CFF2A5E872"
     ]
-  }</code>
+  }
 == Ответ ==
@@ Строка 118: / Строка 117: @@
 |-
 |200
-|Предварительный список удаленного управления конфигурацией
+|RemoteConfigurationManagementPreviewList
 |Успех
 |-
@@ Строка 128: / Строка 127: @@
 === Объекты тела ответа ===
-==== Объект _ <code>RemoteConfigurationManagementPreviewList</code> ====
+==== Объект <code>RemoteConfigurationManagementPreviewList</code> ====
 Список предварительных просмотров заданий удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 135: / Строка 134: @@
 !Описание
 |-
-|превью
+|previews
-|Предварительный просмотр задания удаленного управления конфигурацией []
+|RemoteConfigurationManagementJobPreview[]
 |Список предварительных просмотров заданий удаленного управления конфигурацией.
 |}
-==== Объект _ <code>RemoteConfigurationManagementJobPreview</code> ====
+==== Объект <code>RemoteConfigurationManagementJobPreview</code> ====
 Предварительный просмотр задания удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 147: / Строка 146: @@
 !Описание
 |-
-|уже сконфигурированный EntitiesCount
+|alreadyConfiguredEntitiesCount
-|целое число
+|integer
 |Количество объектов, которые в настоящее время настроены в соответствии с операцией удаленного управления конфигурацией.
 |-
 |targetEntitiesCount
-|целое число
+|integer
 |Количество объектов, которые будут настроены в соответствии с определением удаленного управления конфигурацией после его завершения.
 |-
-|атрибут
+|attribute
-|нить
+|string
 |Атрибут, на который влияет операция.
@@ Строка 165: / Строка 164: @@
 * <code>networkZone</code>
 |-
-|ценность
+|value
-|нить
+|string
 |Значение, которое должно быть присвоено данному атрибуту.
 |-
-|операция
+|operation
-|нить
+|string
 |Операция, выполняемая над данным атрибутом.
@@ Строка 180: / Строка 179: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "previews": [
       {
@@ Строка 190: / Строка 189: @@
       }
     ]
-  }</code>
+  }