GET задание по настройке* - История изменений

ENetrebin в 16:04, 18 октября 2022

2022-10-18T16:04:24Z

← Предыдущая		Версия 16:04, 18 октября 2022
Строка 1:		Строка 1:
	Получает параметры задания конфигурации для ~~ActiveGates~~.		Получает параметры задания конфигурации для АктивныхШлюзов.

	Запрос создает <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/activeGates/remoteConfigurationManagement/{id}</nowiki></code>		\|<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>		\|<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:		Строка 19:
	!Тип		!Тип
	!Описание		!Описание
	!В		!In
	!Необходимый		!Необходимый
	\|-		\|-
	\|~~я бы~~		\|id
	\|~~нить~~		\|string
	\|Идентификатор требуемого задания удаленного управления конфигурацией.		\|Идентификатор требуемого задания удаленного управления конфигурацией.
	\|~~дорожка~~		\|path
	\|требуется		\|требуется
	\|}		\|}
Строка 41:		Строка 38:
	\|-		\|-
	\|200		\|200
	\|~~Задание удаленного управления конфигурацией~~		\|RemoteConfigurationManagementJob
	\|Успех		\|Успех
	\|-		\|-
Строка 51:		Строка 48:
	=== Объекты тела ответа ===		=== Объекты тела ответа ===

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

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

	==== Объект _ <code>RemoteConfigurationManagementOperation</code> ====		==== Объект <code>RemoteConfigurationManagementOperation</code> ====
	Определение одной операции удаленного управления конфигурацией.		Определение одной операции удаленного управления конфигурацией.
	{\| class="wikitable"		{\| class="wikitable"
Строка 103:		Строка 100:
	!Описание		!Описание
	\|-		\|-
	\|~~атрибут~~		\|attribute
	\|нить		\|нить
	\|Атрибут, на который влияет операция.		\|Атрибут, на который влияет операция.
Строка 113:		Строка 110:
	* <code>networkZone</code>		* <code>networkZone</code>
	\|-		\|-
	\|~~ценность~~		\|value
	\|нить		\|нить
	\|Значение, которое должно быть присвоено данному атрибуту.		\|Значение, которое должно быть присвоено данному атрибуту.
	\|-		\|-
	\|~~операция~~		\|operation
	\|нить		\|нить
	\|Операция, выполняемая над данным атрибутом.		\|Операция, выполняемая над данным атрибутом.

ENetrebin: Новая страница: «Получает параметры задания конфигурации для ActiveGates. Запрос создает `application/json`поле...»

2022-10-17T15:30:37Z

Новая страница: «Получает параметры задания конфигурации для ActiveGates. Запрос создает <code>application/json</code>поле...»

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

Получает параметры задания конфигурации для ActiveGates.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<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>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

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

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Задание удаленного управления конфигурацией
|Успех
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}

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

==== Объект _ <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>

GET задание по настройке* - История изменений

ENetrebin в 16:04, 18 октября 2022

ENetrebin: Новая страница: «Получает параметры задания конфигурации для ActiveGates. Запрос создает application/jsonполе...»

ENetrebin: Новая страница: «Получает параметры задания конфигурации для ActiveGates. Запрос создает `application/json`поле...»