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

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

2025-01-02T17:17:32Z

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

	Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного синтетического местоположения .		Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного синтетического местоположения .

Строка 106:		Строка 108:
	"deploymentType": "KUBERNETES",		"deploymentType": "KUBERNETES",
	"autoUpdateChromium": true		"autoUpdateChromium": true
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 143:		Строка 145:
	"entityId": "string",		"entityId": "string",
	"geoLocationId": "string"		"geoLocationId": "string"
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 171:		Строка 173:
	"locationNodeOutageDelayInMillis": 5000		"locationNodeOutageDelayInMillis": 5000
	}		}
	'~~</code>~~		'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 189:		Строка 191:
	"availabilityNodeOutage": false,		"availabilityNodeOutage": false,
	"locationNodeOutageDelayInMillis": 5000		"locationNodeOutageDelayInMillis": 5000
	}~~</code>~~		}

	==== Тело ответа ====		==== Тело ответа ====
Строка 195:		Строка 197:
	"entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",		"entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
	"geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"		"geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"
	}~~</code>~~		}

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

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

2024-12-26T10:28:38Z

← Предыдущая версия		Версия от 10:28, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations</nowiki></code>
	\|-		\|-
Строка 96:		Строка 96:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"nodes": [		"nodes": [
	"string"		"string"
Строка 140:		Строка 140:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"geoLocationId": "string"		"geoLocationId": "string"
Строка 153:		Строка 153:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations'</nowiki> \		<curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations'</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' \
Строка 177:		Строка 177:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"type": "PRIVATE",		"type": "PRIVATE",
	"name": "REST example - Linz",		"name": "REST example - Linz",
Строка 192:		Строка 192:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",		"entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
	"geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"		"geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"

ENetrebin: Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»

2022-10-20T16:08:44Z

Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»

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

Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного синтетического местоположения .

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

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

== Параметр ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|SyntheticLocation
|Тело JSON запроса. Содержит параметры новой частной синтетической локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocation</code> ====
Конфигурация синтетической локации.

Параметры countryCode , regionCode , city являются необязательными, поскольку их можно получить на основе широты и долготы местоположения.

Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|nodes
|string[]
|Список синтетических узлов, принадлежащих локации.

Вы можете получить список доступных узлов с помощью вызова GET all nodes .
|по желанию
|-
|availabilityLocationOutage
|boolean
|Предупреждение об отключении местоположения включено ( <code>true</code>) или отключено ( <code>false</code>).
|по желанию
|-
|availabilityNodeOutage
|boolean
|Оповещение об отключении узла включено ( <code>true</code>) или отключено ( <code>false</code>).

Если включено, сбой ''любого'' узла в локации вызывает оповещение.
|по желанию
|-
|locationNodeOutageDelayInMinutes
|integer
|Оповещение, если сбой местоположения или узла длится дольше ''X'' минут.

Применимо только в том случае, если для параметраavailabilityLocationOutage или availabilityNodeOutage задано значение .<code>true</code>
|по желанию
|-
|availabilityNotificationsEnabled
|boolean
|Уведомления о сбое местоположения и узла включены ( <code>true</code>) или отключены ( <code>false</code>).
|по желанию
|-
|deploymentType
|string
|Тип развертывания местоположения:

* <code>STANDARD</code>: расположение развернуто в Windows или Linux.
* <code>KUBERNETES</code>: расположение развернуто в Kubernetes.

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

* <code>KUBERNETES</code>
* <code>STANDARD</code>
|по желанию
|-
|autoUpdateChromium
|boolean
|Автоматическое обновление Chromium включено ( <code>true</code>) или отключено ( <code>false</code>).
|по желанию
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"nodes": [
"string"
],
"availabilityLocationOutage": true,
"availabilityNodeOutage": true,
"locationNodeOutageDelayInMinutes": 1,
"availabilityNotificationsEnabled": true,
"deploymentType": "KUBERNETES",
"autoUpdateChromium": true
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|SyntheticLocationIdsDto
|Успех. Частная локация создана. Ответ содержит идентификатор нового местоположения.
|}

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

==== Объект <code>SyntheticLocationIdsDto</code> ====
DTO для синтетических идентификаторов местоположения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта для передачи
|-
|geoLocationId
|string
|Идентификатор геолокации для передачи
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "string",
"geoLocationId": "string"
}</code>

== Пример ==
В этом примере запрос создает новое частное синтетическое местоположение. Это место находится в Линце, Австрия . Он использует синтетический узел с идентификатором 290433380 .

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

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

==== Curl ====
<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"290433380"
],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}
'</code>

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

==== Тело запроса ====
<code>{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["290433380"],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}</code>

==== Тело ответа ====
<code>{
"entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
"geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"
}</code>

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