POST задание автообновления - История изменений

IKuznetsov в 14:10, 24 декабря 2024

2024-12-24T14:10:21Z

← Предыдущая версия		Версия от 14:10, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / POST задание автообновления'''''		'''''[[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=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B5%D0%A8%D0%BB%D1%8E%D0%B7%D1%8B,-%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%97%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B9 Задания автообновлений] / POST задание автообновления'''''

	Создает новое задание автоматического обновления для указанного АктивногоШлюза.		Создает новое задание автоматического обновления для указанного АктивногоШлюза.
Строка 8:		Строка 8:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
	\|-		\|-
Строка 147:		Строка 147:
	"targetVersion": "1.190.0.20200301-130000",		"targetVersion": "1.190.0.20200301-130000",
	"error": "string"		"error": "string"
	}~~</code>~~		}
	==Ответ==		==Ответ==
	===Коды ответов===		===Коды ответов===
Строка 273:		Строка 273:
	"targetVersion": "1.190.0.20200301-130000",		"targetVersion": "1.190.0.20200301-130000",
	"error": "string"		"error": "string"
	}~~</code>~~		}
	==Проверить полезную нагрузку==		==Проверить полезную нагрузку==
	Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.		Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Строка 280:		Строка 280:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
	\|-		\|-
Строка 313:		Строка 313:
	--data-raw '{		--data-raw '{
	"targetVersion": "1.198.0.20200630-163221"		"targetVersion": "1.198.0.20200630-163221"
	}'~~</code>~~		}'
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
Строка 319:		Строка 319:
	<{		<{
	"targetVersion": "1.198.0.20200630-163221"		"targetVersion": "1.198.0.20200630-163221"
	}~~</code>~~		}
	====Тело ответа====		====Тело ответа====
	<{		<{
Строка 336:		Строка 336:
	"error": null,		"error": null,
	"duration": null		"duration": null
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	201		201

IKuznetsov в 18:57, 23 декабря 2024

2024-12-23T18:57:26Z

← Предыдущая версия		Версия от 18:57, 23 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / ~~[[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|~~Эндпойнты среды]] / ~~[[API Ключ-АСТРОМ#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|~~АктивныеШлюзы]] / Задания автообновлений / POST задание автообновления'''''		'''''[[API АппОптима]] / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / POST задание автообновления'''''

	Создает новое задание автоматического обновления для указанного АктивногоШлюза.		Создает новое задание автоматического обновления для указанного АктивногоШлюза.
Строка 132:		Строка 132:
	===Модель JSON тела запроса===		===Модель JSON тела запроса===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"jobState": "SUCCEED",		"jobState": "SUCCEED",
	"updateMethod": "AUTOMATIC",		"updateMethod": "AUTOMATIC",
Строка 258:		Строка 258:
	\|}		\|}
	===Модель JSON тела ответа===		===Модель JSON тела ответа===
	<~~code>~~{		<{
	"jobState": "SUCCEED",		"jobState": "SUCCEED",
	"updateMethod": "AUTOMATIC",		"updateMethod": "AUTOMATIC",
Строка 308:		Строка 308:
	Токен API передается в заголовке авторизации .		Токен API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl -L -X POST '<nowiki>https://mySampleEnv.live.~~astromkey~~.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \		<curl -L -X POST '<nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Content-Type: application/json' \		-H 'Content-Type: application/json' \
Строка 315:		Строка 315:
	}'</code>		}'</code>
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv.live.~~astromkey~~.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"targetVersion": "1.198.0.20200630-163221"		"targetVersion": "1.198.0.20200630-163221"
	}</code>		}</code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"jobId": "-7240069678607892845",		"jobId": "-7240069678607892845",
	"jobState": "PENDING",		"jobState": "PENDING",

ENetrebin: /* Curl */

2024-06-05T15:07:39Z

Curl

← Предыдущая версия		Версия от 15:07, 5 июня 2024
Строка 308:		Строка 308:
	Токен API передается в заголовке авторизации .		Токен API передается в заголовке авторизации .
	====Curl====		====Curl====
	<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \		<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.astromkey.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
	-H 'Content-Type: application/json' \		-H 'Content-Type: application/json' \
Строка 315:		Строка 315:
	}'</code>		}'</code>
	====URL запроса====		====URL запроса====
	<code><nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>		<code><nowiki>https://mySampleEnv.live.astromkey.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<code>{		<code>{

ENetrebin в 20:25, 2 июня 2024

2024-06-02T20:25:01Z

← Предыдущая версия		Версия от 20:25, 2 июня 2024
Строка 1:		Строка 1:
			'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.90.D0.BA.D1.82.D0.B8.D0.B2.D0.BD.D1.8B.D0.B5.D0.A8.D0.BB.D1.8E.D0.B7.D1.8B\|АктивныеШлюзы]] / Задания автообновлений / POST задание автообновления'''''

	Создает новое задание автоматического обновления для указанного АктивногоШлюза.		Создает новое задание автоматического обновления для указанного АктивногоШлюза.

ENetrebin: Новая страница: «Создает новое задание автоматического обновления для указанного АктивногоШлюза. Задан...»

2024-06-02T20:23:23Z

Новая страница: «Создает новое задание автоматического обновления для указанного АктивногоШлюза. Задан...»

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

Создает новое задание автоматического обновления для указанного АктивногоШлюза.

Задание обновляет АктивныйШлюз до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий АктивногоШлюза .

Запрос потребляет и производит <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!необходимость
|-
|старение
|string
|ID необходимого АктивногоШлюза.
|path
|по желанию
|-
|body
|Обновить задание
|Тело запроса в формате JSON, содержащее параметры задания обновления.
|body
|обязательный
|}
===Объекты тела запроса===
====объект <code>UpdateJob</code>====
Конфигурация задания обновления АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
!необходимые
|-
|jobState
|string
|Статус задания обновления.
Элемент может содержать эти значения
*<code>FAILED</code>
*<code>IN_PROGRESS</code>
*<code>PENDING</code>
*<code>ROLLBACK</code>
*<code>SCHEDULED</code>
*<code>SKIPPED</code>
*<code>SUCCEED</code>
|по желанию
|-
|updateMethod
|string
|Метод обновления АктивногоШлюза или его компонента.
Элемент может содержать эти значения
*<code>AUTOMATIC</code>
*<code>MANUAL_INSTALLATION</code>
*<code>ON_DEMAND</code>
|по желанию
|-
|updateType
|string
|Компонент, который нужно обновить.
Элемент может содержать эти значения
*<code>ACTIVE_GATE</code>
*<code>REMOTE_PLUGIN_AGENT</code>
*<code>SYNTHETIC</code>
*<code>Z_REMOTE</code>
|по желанию
|-
|agType
|string
|Тип АктивныйШлюз.
Элемент может содержать эти значения
*<code>CLUSTER</code>
*<code>ENVIRONMENT</code>
*<code>ENVIRONMENT_MULTI</code>
|по желанию
|-
|startVersion
|string
|Первоначальная версия АктивныйШлюз.
|по желанию
|-
|окружающая среда
|string []
|Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
|по желанию
|-
|отменяемый
|логический
|В настоящий момент задание можно ( <code>true</code>) или нельзя ( <code>false</code>) отменить.
|по желанию
|-
|jobId
|string
|Идентификатор задания обновления.
|по желанию
|-
|отметка времени
|целое число
|Отметка времени завершения задания обновления.
<code>null</code>Значение означает , что работа по - прежнему работает.
|по желанию
|-
|продолжительность
|целое число
|Продолжительность обновления в миллисекундах.
|по желанию
|-
|targetVersion
|string
|Целевая версия обновления.
Укажите версию в <code><major>.<minor>.<revision>.<timestamp></code>формате.

Чтобы обновить до последней доступной версии, используйте <code>latest</code>значение.
|обязательный
|-
|ошибка
|string
|Информация об ошибке обновления.
|по желанию
|}
===Модель JSON тела запроса===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "ACTIVE_GATE",
"agType": "ENVIRONMENT",
"startVersion": "1.185.0.20200201-120000",
"environments": [
"string"
],
"cancelable": false,
"jobId": "-3524498778810258605",
"timestamp": 1582031917814,
"duration": 3608000,
"targetVersion": "1.190.0.20200301-130000",
"error": "string"
}</code>
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|Обновить задание
|Успех. Обновление-задание создано.
|-
|400
|Конверт ошибки
|Не удалось. Введены неверные данные.
|}
===Объекты тела ответа===
====объект <code>UpdateJob</code>====
Конфигурация задания обновления АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
!необходимые
|-
|jobState
|string
|Статус задания обновления.
Элемент может содержать эти значения
*<code>FAILED</code>
*<code>IN_PROGRESS</code>
*<code>PENDING</code>
*<code>ROLLBACK</code>
*<code>SCHEDULED</code>
*<code>SKIPPED</code>
*<code>SUCCEED</code>
|по желанию
|-
|updateMethod
|string
|Метод обновления АктивныйШлюз или его компонента.
Элемент может содержать эти значения
*<code>AUTOMATIC</code>
*<code>MANUAL_INSTALLATION</code>
*<code>ON_DEMAND</code>
|по желанию
|-
|updateType
|string
|Компонент, который нужно обновить.
Элемент может содержать эти значения
*<code>ACTIVE_GATE</code>
*<code>REMOTE_PLUGIN_AGENT</code>
*<code>SYNTHETIC</code>
*<code>Z_REMOTE</code>
|по желанию
|-
|agType
|string
|Тип АктивныйШлюз.
Элемент может содержать эти значения
*<code>CLUSTER</code>
*<code>ENVIRONMENT</code>
*<code>ENVIRONMENT_MULTI</code>
|по желанию
|-
|startVersion
|string
|Первоначальная версия АктивногоШлюза.
|по желанию
|-
|окружающая среда
|string []
|Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться.
|по желанию
|-
|отменяемый
|логический
|В настоящий момент задание можно ( <code>true</code>) или нельзя ( <code>false</code>) отменить.
|по желанию
|-
|jobId
|string
|Идентификатор задания обновления.
|по желанию
|-
|отметка времени
|целое число
|Отметка времени завершения задания обновления.
<code>null</code>Значение означает , что работа по - прежнему работает.
|по желанию
|-
|продолжительность
|целое число
|Продолжительность обновления в миллисекундах.
|по желанию
|-
|targetVersion
|string
|Целевая версия обновления.
Укажите версию в <code><major>.<minor>.<revision>.<timestamp></code>формате.

Чтобы обновить до последней доступной версии, используйте <code>latest</code>значение.
|обязательный
|-
|ошибка
|string
|Информация об ошибке обновления.
|по желанию
|}
===Модель JSON тела ответа===
<code>{
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "ACTIVE_GATE",
"agType": "ENVIRONMENT",
"startVersion": "1.185.0.20200201-120000",
"environments": [
"string"
],
"cancelable": false,
"jobId": "-3524498778810258605",
"timestamp": 1582031917814,
"duration": 3608000,
"targetVersion": "1.190.0.20200301-130000",
"error": "string"
}</code>
==Проверить полезную нагрузку==
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

Запрос потребляет <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator</nowiki></code>
|}
===Аутентификация===
Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
===Ответ===
====Коды ответов====
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
| -
|Подтверждено. Отправленное задание на обновление действительно. У ответа нет тела.
|-
|400
|Конверт ошибки
|Не удалось. Введены неверные данные.
|}
==Пример==
В этом примере запрос создает задание обновления для обновления АктивногоШлюза с идентификатором 1812885988 до версии 1.198.0.20200630-163221 .

Токен API передается в заголовке авторизации .
====Curl====
<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates/1812885988/updateJobs'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"targetVersion": "1.198.0.20200630-163221"
}'</code>
====URL запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/activeGates/1812885988/updateJobs</nowiki></code>
====Тело запроса====
<code>{
"targetVersion": "1.198.0.20200630-163221"
}</code>
====Тело ответа====
<code>{
"jobId": "-7240069678607892845",
"jobState": "PENDING",
"updateMethod": null,
"updateType": null,
"cancelable": true,
"startVersion": "1.195.5.20200522-174041",
"targetVersion": "1.198.0.20200630-163221",
"timestamp": null,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": null
}</code>
====Код ответа====
201