Создание новой частной синтетической локации (POST локация): различия между версиями

Текущая версия от 07:46, 7 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Лог мониторинга / Создание новой частной синтетической локации (POST локация)

Этот вызов API создает новую синтетическую локацию. Запрос потребляет и создает полезную нагрузку application/json.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/synthetic/locations

Параметры

Параметр	Тип	Описание	В	Обязательно
body	SyntheticLocation	Тело JSON запроса. Содержит параметры новой частной синтетической локации	body	Нет

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

Объект `SyntheticLocation`

Конфигурация синтетической локации. Реальный набор полей зависит от типа локации. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON.

Элемент	Тип	Описание	Обязательно
nodes	string[]	Список синтетических узлов, принадлежащих локации. Вы можете получить список доступных узлов с помощью вызова GET all nodes.	optional
availabilityLocationOutage	boolean	Предупреждение об отключении местоположения включено `(true)` или отключено `(false)`.	optional
availabilityNodeOutage	boolean	Оповещение об отключении узла включено `(true)` или отключено `(false)`. Если включено, сбой любого узла в локации вызывает оповещение.	optional
locationNodeOutageDelayInMinutes	integer	Оповещение, если сбой местоположения или узла длится дольше X минут. Применимо только в том случае, если для параметра availabilityLocationOutage или availabilityNodeOutage задано значение true.	optional
availabilityNotificationsEnabled	boolean	Уведомления о сбое местоположения и узла включены `(true)` или отключены `(false)`.	optional
deploymentType	string	Тип развертывания местоположения: `STANDARD`: Локация развернута в Windows или Linux. `KUBERNETES`: Локация развернута в Kubernetes.	optional
minAGCount	integer	Минимальное количество АктивныхШлюзов, развернутых для локации (требуется для локации Kubernetes).	optional
maxAGCount	integer	Максимальное количество АктивныхШлюзов, развернутых для локации (требуется для локации Kubernetes).	optional
nodeSize	string	Размер контейнерного узла, развернутого для расположения (требуется для расположения Kubernetes): `XS`: Extra small `S`: Small `M`: Medium	optional
autoUpdateChromium	boolean	Автоматическое обновление Chromium включено `(true)` или отключено `(false)`.	optional

Ответ

Коды ответа

Код	Тип	Описание
201	SyntheticLocationIdsDto	Success. The private location has been created. The response contains the ID of the new location.

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

Объект `SyntheticLocationIdsDto`

Элемент	Тип	Описание
entityId	string	Идентификатор объекта для передачи
geoLocationId	string	Идентификатор геолокации для передачи

JSON-модель тела ответа

<{
  "entityId": "string",
  "geoLocationId": "string"
}

Пример

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

Токен API передается в заголовке Authorization.

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

Curl

curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations' \ -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 } '

URL-адрес запроса

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations

Тело запроса

<{
  "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
}

Тело ответа

<{
  "entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
  "geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Лог мониторинга]] / [[Создание новой частной синтетической локации (POST локация)]]'''''
 Этот вызов API создает новую синтетическую локацию. Запрос потребляет и создает полезную нагрузку <code>application/json</code>.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/cluster/v2/synthetic/locations</code>
@@ Строка 27: / Строка 29: @@
 !Тип
 !Описание
-!
+!Обязательно
 |-
 |nodes
@@ Строка 122: / Строка 124: @@
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "entityId": "string",
     "geoLocationId": "string"
-  }</code>
+  }
 ==Пример==
 В этом примере запрос создает новое частное синтетическое местоположение. Это место находится в '''Линце''', '''Австрия'''. Он использует синтетический узел с идентификатором '''290433380'''.
@@ Строка 156: / Строка 158: @@
 ==== Тело запроса ====
-  <code>{
+  <{
     "type": "PRIVATE",
     "name": "REST example - Linz",
@@ Строка 168: / Строка 170: @@
     "availabilityNodeOutage": false,
     "locationNodeOutageDelayInMillis": 5000
-  }</code>
+  }
 ====Тело ответа====
-  <code>{
+  <{
     "entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
     "geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>