IKuznetsov в 16:28, 2 января 2025

2025-01-02T16:28:32Z

← Предыдущая версия		Версия от 16:28, 2 января 2025
Строка 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%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 АктивныйШлюз] / POST задание конфигурации*'''''

	Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.		Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.
Строка 99:		Строка 101:
	"0x4928065d"		"0x4928065d"
	]		]
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 217:		Строка 219:
	"startTime": "2020-11-05T08:15:30.144Z",		"startTime": "2020-11-05T08:15:30.144Z",
	"endTime": "2020-11-05T08:15:30.144Z"		"endTime": "2020-11-05T08:15:30.144Z"
	}~~</code>~~		}

	== Проверить полезную нагрузку ==		== Проверить полезную нагрузку ==

IKuznetsov в 20:52, 25 декабря 2024

2024-12-25T20:52:08Z

← Предыдущая версия		Версия от 20:52, 25 декабря 2024
Строка 3:		Строка 3:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>
	\|-		\|-
Строка 87:		Строка 87:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"operations": [		"operations": [
	{		{
Строка 202:		Строка 202:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"timeoutTime": "2020-11-05T08:15:30.144Z",		"timeoutTime": "2020-11-05T08:15:30.144Z",
	"processedEntitiesCount": 1,		"processedEntitiesCount": 1,
Строка 225:		Строка 225:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/validator</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/validator</nowiki></code>
	\|-		\|-

ENetrebin в 15:30, 18 октября 2022

2022-10-18T15:30:11Z

Внесённые изменения

ENetrebin: Новая страница: « Запрос потребляет `application/json`полезную нагрузку. {| class="wikitable" | rowspan="3" |ПОЧТА |Удалось...»

2022-10-17T15:21:19Z

Новая страница: « Запрос потребляет <code>application/json</code>полезную нагрузку. {| class="wikitable" | rowspan="3" |ПОЧТА |Удалось...»

Новая страница

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

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

== Параметры ==
Вы идентифицируете свои ActiveGate по их идентификаторам. Используйте запрос GET all ActiveGate , чтобы узнать идентификаторы ActiveGate, которые вы хотите настроить.
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|тело
|Операция удаленного управления конфигурацией Active Gate Request
|Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.
|тело
|требуется
|}

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

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

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

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

* <code>group</code>
* <code>hostGroup</code>
* <code>networkZone</code>
|требуется
|-
|ценность
|нить
|Значение, которое должно быть присвоено данному атрибуту.
|по желанию
|-
|операция
|нить
|Операция, выполняемая над данным атрибутом.

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

* <code>clear</code>
* <code>set</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"operations": [
{
"attribute": "networkZone",
"value": "exampleNetworkZoneName",
"operation": "set"
}
],
"entities": [
"0x2b7c0b02",
"0x4928065d"
]
}</code>

== Ответ ==
Ответ не отправляется клиенту до тех пор, пока все ActiveGate, определенные в полезной нагрузке, не будут обработаны. ActiveGate считается обработанным, когда ему отправляется сообщение о реконфигурации; фактическая реконфигурация обрабатывается ActiveGate независимо.

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|Задание удаленного управления конфигурацией
|Созданный
|-
|400
|RemoteConfigurationManagementValidationResult
|Не удалось. Ввод недействителен.
|-
|409
|
|В настоящее время выполняется другое задание удаленного управления конфигурацией.
|}

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

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

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

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

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

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

* <code>group</code>
* <code>hostGroup</code>
* <code>networkZone</code>
|-
|ценность
|нить
|Значение, которое должно быть присвоено данному атрибуту.
|-
|операция
|нить
|Операция, выполняемая над данным атрибутом.

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

* <code>clear</code>
* <code>set</code>
|}

=== JSON-модель тела ответа ===
<code>{
"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"
}</code>

== Проверить полезную нагрузку ==
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

=== Ответ ===

==== Коды ответов ====
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
|
|Успех. Ответ не имеет тела.
|-
|400
|RemoteConfigurationManagementValidationResult
|Не удалось. Ввод недействителен.
|}

POST задание конфигурации* - История изменений

IKuznetsov в 16:28, 2 января 2025

IKuznetsov в 20:52, 25 декабря 2024

ENetrebin в 15:30, 18 октября 2022

ENetrebin: Новая страница: « Запрос потребляет application/jsonполезную нагрузку. {| class="wikitable" | rowspan="3" |ПОЧТА |Удалось...»

ENetrebin: Новая страница: « Запрос потребляет `application/json`полезную нагрузку. {| class="wikitable" | rowspan="3" |ПОЧТА |Удалось...»