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

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


Запрос потребляет <code>application/json</code>полезную нагрузку.
Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЧТА
| rowspan="2" |POST
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview</nowiki></code>
|-
|-
|SaaS
|Среда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/preview</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 27: Строка 24:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимый
|-
|-
|тело
|body
|Операция удаленного управления конфигурацией Active Gate Request
|RemoteConfigurationManagementOperationActiveGateRequest
|Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.
|Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.
|тело
|body
|требуется
|требуется
|}
|}
Строка 39: Строка 36:
=== Объекты тела запроса ===
=== Объекты тела запроса ===


==== Объект _ <code>RemoteConfigurationManagementOperationActiveGateRequest</code> ====
==== Объект <code>RemoteConfigurationManagementOperationActiveGateRequest</code> ====
Запрос на создание операции удаленного управления конфигурацией.
Запрос на создание операции удаленного управления конфигурацией.
{| class="wikitable"
{| class="wikitable"
Строка 45: Строка 42:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|операции
|operations
|Операция удаленного управления конфигурацией []
|RemoteConfigurationManagementOperation[]
|Список операций удаленного управления конфигурацией, которые необходимо выполнить.
|Список операций удаленного управления конфигурацией, которые необходимо выполнить.
|требуется
|требуется
|-
|-
|сущности
|entities
|строка []
|string[]
|Список идентификаторов сущностей, для которых должно выполняться удаленное управление конфигурацией.
|Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией.
|требуется
|требуется
|}
|}


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


Строка 77: Строка 74:
|требуется
|требуется
|-
|-
|ценность
|value
|нить
|string
|Значение, которое должно быть присвоено данному атрибуту.
|Значение, которое должно быть присвоено данному атрибуту.
|по желанию
|по желанию
|-
|-
|операция
|operation
|нить
|string
|Операция, выполняемая над данным атрибутом.
|Операция, выполняемая над данным атрибутом.


Строка 118: Строка 115:
|-
|-
|200
|200
|Предварительный список удаленного управления конфигурацией
|RemoteConfigurationManagementPreviewList
|Успех
|Успех
|-
|-
Строка 135: Строка 132:
!Описание
!Описание
|-
|-
|превью
|previews
|Предварительный просмотр задания удаленного управления конфигурацией []
|RemoteConfigurationManagementJobPreview[]
|Список предварительных просмотров заданий удаленного управления конфигурацией.
|Список предварительных просмотров заданий удаленного управления конфигурацией.
|}
|}


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


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



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

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

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

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

Запрос использует в качестве полезной нагрузки application/json формат.

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

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

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

Параметры

Параметр Тип Описание In Необходимый
body RemoteConfigurationManagementOperationActiveGateRequest Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией. body требуется

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

Объект RemoteConfigurationManagementOperationActiveGateRequest

Запрос на создание операции удаленного управления конфигурацией.

Элемент Тип Описание Необходимость
operations RemoteConfigurationManagementOperation[] Список операций удаленного управления конфигурацией, которые необходимо выполнить. требуется
entities string[] Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией. требуется

Объект RemoteConfigurationManagementOperation

Определение одной операции удаленного управления конфигурацией.

Элемент Тип Описание Необходимость
attribute string Атрибут, на который влияет операция.

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

  • group
  • hostGroup
  • networkZone
требуется
value string Значение, которое должно быть присвоено данному атрибуту. по желанию
operation string Операция, выполняемая над данным атрибутом.

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

  • clear
  • set
требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entities": [
    "0x2b7c0b02",
    "0x4928065d"
  ]
}

Ответ

Коды ответов

Код Тип Описание
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"
    }
  ]
}