PUT локация* - История изменений

IKuznetsov в 17:06, 2 января 2025

2025-01-02T17:06:16Z

← Предыдущая версия		Версия от 17:06, 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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [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=JSON%20%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетические локации] / PUT локация*'''''

	Обновляет существующее частное синтетическое местоположение.		Обновляет существующее частное синтетическое местоположение.

IKuznetsov в 14:28, 26 декабря 2024

2024-12-26T14:28:32Z

← Предыдущая версия		Версия от 14:28, 26 декабря 2024
Строка 25:		Строка 25:
	\|locationId		\|locationId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ синтетического местоположения, которое необходимо обновить.		\|Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.
	\|path		\|path
	\|требуется		\|требуется
Строка 71:		Строка 71:
	],		],
	"status": "ENABLED"		"status": "ENABLED"
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 83:		Строка 83:
	\|locationId		\|locationId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ синтетического местоположения, которое необходимо обновить.		\|Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.
	\|path		\|path
	\|требуется		\|требуется
Строка 129:		Строка 129:
	],		],
	"status": "ENABLED"		"status": "ENABLED"
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 158:		Строка 158:
	]		]
	}		}
	'~~</code>~~		'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 173:		Строка 173:
	"longitude": 14.287399,		"longitude": 14.287399,
	"nodes": ["93302281", "353074222"]		"nodes": ["93302281", "353074222"]
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	204		204

IKuznetsov в 08:59, 26 декабря 2024

2024-12-26T08:59:06Z

← Предыдущая версия		Версия от 08:59, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|PUT		\| rowspan="2" \|PUT
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
	\|-		\|-
Строка 62:		Строка 62:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"type": "PRIVATE",		"type": "PRIVATE",
	"name": "Linz Location",		"name": "Linz Location",
Строка 120:		Строка 120:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"type": "PRIVATE",		"type": "PRIVATE",
	"name": "Linz Location",		"name": "Linz Location",
Строка 141:		Строка 141:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X PUT \		<curl -X PUT \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 164:		Строка 164:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"type": "PRIVATE",		"type": "PRIVATE",
	"name": "Linz",		"name": "Linz",

ENetrebin: Новая страница: «Обновляет существующее частное синтетическое местоположение. Запрос потребляет в каче...»

2022-10-24T15:02:47Z

Новая страница: «Обновляет существующее частное синтетическое местоположение. Запрос потребляет в каче...»

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

Обновляет существующее частное синтетическое местоположение.

Запрос потребляет в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |PUT
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
|}

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

== Параметры ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|locationId
|string
|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
|path
|требуется
|-
|body
|SyntheticLocationUpdate
|Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocationUpdate</code> ====
Обновление синтетической локации. Фактический объект зависит от типа местоположения.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code>-> SyntheticPublicLocationUpdate
* <code>PRIVATE</code>-> PrivateSyntheticLocationUpdate

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

* <code>PRIVATE</code>
* <code>PUBLIC</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"type": "PRIVATE",
"name": "Linz Location",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
],
"status": "ENABLED"
}</code>

== Ответ ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимый
|-
|locationId
|string
|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
|path
|требуется
|-
|body
|SyntheticLocationUpdate
|Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocationUpdate</code> ====
Обновление синтетической локации. Фактический объект зависит от типа местоположения.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code>-> SyntheticPublicLocationUpdate
* <code>PRIVATE</code>-> PrivateSyntheticLocationUpdate

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

* <code>PRIVATE</code>
* <code>PUBLIC</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"type": "PRIVATE",
"name": "Linz Location",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
],
"status": "ENABLED"
}</code>

== Пример ==
В этом примере запрос обновляет приватное синтетическое расположение из примера POST-запроса . Он меняет название местоположения на Linz и добавляет узел Synthetic с идентификатором 353074222 .

Маркер API передается в заголовке авторизации .

Код ответа 204 означает, что обновление прошло успешно.

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

==== Curl ====
<code>curl -X PUT \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281",
"353074222"
]
}
'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45</nowiki></code>

==== Тело запроса ====
<code>{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["93302281", "353074222"]
}</code>

==== Код ответа ====
204