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

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

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

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

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

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

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

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

@@ Строка 1: / Строка 1: @@
-Получает параметры задания конфигурации для ActiveGates.
+'''''[[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%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BF%D0%BE%20%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B5-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B9%D0%A8%D0%BB%D1%8E%D0%B7,-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 АктивныйШлюз] / GET задание по настройке*'''''
-Запрос создает <code>application/json</code>полезную нагрузку.
+Получает параметры задания конфигурации для АктивныхШлюзов.
+Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="2" |GET
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/{id}</nowiki></code>
 |-
-|SaaS
+|Среда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/{id}</nowiki></code>
-|-
-|Окружающая среда ActiveGate
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/{id}</nowiki></code>
 |}
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( <code>activeGates.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( <code>activeGates.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 22: / Строка 21: @@
 !Тип
 !Описание
-!В
+!In
 !Необходимый
 |-
-|я бы
+|id
-|нить
+|string
 |Идентификатор требуемого задания удаленного управления конфигурацией.
-|дорожка
+|path
 |требуется
 |}
@@ Строка 41: / Строка 40: @@
 |-
 |200
-|Задание удаленного управления конфигурацией
+|RemoteConfigurationManagementJob
 |Успех
 |-
@@ Строка 51: / Строка 50: @@
 === Объекты тела ответа ===
-==== Объект _ <code>RemoteConfigurationManagementJob</code> ====
+==== Объект <code>RemoteConfigurationManagementJob</code> ====
 Задание удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 58: / Строка 57: @@
 !Описание
 |-
-|тайм-аутВремя
+|timeoutTime
-|нить
+|string
 |Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.SSS'Z'), когда истечет время ожидания запущенного задания удаленного управления конфигурацией. Это поле присутствует только для запущенных заданий.
 |-
-|обработаноEntitiesCount
+|processedEntitiesCount
-|целое число
+|integer
 |Количество объектов, которые уже были обработаны на момент создания ответа.
 |-
-|TotalEntitiesCount
+|totalEntitiesCount
-|целое число
+|integer
 |Общее количество объектов для обработки.
 |-
-|операции
+|operations
-|Операция удаленного управления конфигурацией []
+|RemoteConfigurationManagementOperation[]
 |Список выполненных заданий удаленного управления конфигурацией.
 |-
-|тип объекта
+|entityType
-|нить
+|string
 |Тип объектов, измененных удаленным управлением конфигурацией.
@@ Строка 83: / Строка 82: @@
 * <code>ONE_AGENT</code>
 |-
-|я бы
+|id
-|нить
+|string
 |Идентификатор задания удаленного управления конфигурацией.
 |-
-|время начала
+|startTime
-|нить
+|string
 |Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
 |-
-|время окончания
+|endTime
-|нить
+|string
 |Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.
 |}
-==== Объект _ <code>RemoteConfigurationManagementOperation</code> ====
+==== Объект <code>RemoteConfigurationManagementOperation</code> ====
 Определение одной операции удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 103: / Строка 102: @@
 !Описание
 |-
-|атрибут
+|attribute
 |нить
 |Атрибут, на который влияет операция.
@@ Строка 113: / Строка 112: @@
 * <code>networkZone</code>
 |-
-|ценность
+|value
 |нить
 |Значение, которое должно быть присвоено данному атрибуту.
 |-
-|операция
+|operation
 |нить
 |Операция, выполняемая над данным атрибутом.
@@ Строка 128: / Строка 127: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "timeoutTime": "2020-11-05T08:15:30.144Z",
     "processedEntitiesCount": 1,
@@ Строка 143: / Строка 142: @@
     "startTime": "2020-11-05T08:15:30.144Z",
     "endTime": "2020-11-05T08:15:30.144Z"
-  }</code>
+  }