PUT локация*: различия между версиями

Текущая версия от 17:06, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v1 / Синтетические локации / PUT локация*

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

Запрос потребляет в качестве полезной нагрузкиapplication/json формат.

PUT	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}`
PUT	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}`

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( ExternalSyntheticIntegration) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .

Параметр	Тип	Описание	In	Необходимость
locationId	string	Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.	path	требуется
body	SyntheticLocationUpdate	Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.	body	по желанию

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

Объект `SyntheticLocationUpdate`

Обновление синтетической локации. Фактический объект зависит от типа местоположения.

Элемент	Тип	Описание	Необходимость
type	string	Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: `PUBLIC`-> SyntheticPublicLocationUpdate `PRIVATE`-> PrivateSyntheticLocationUpdate Элемент может содержать эти значения `PRIVATE` `PUBLIC`	требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "type": "PRIVATE",
  "name": "Linz Location",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "93302281"
  ],
  "status": "ENABLED"
}

Ответ

Параметр	Тип	Описание	In	Необходимый
locationId	string	Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.	path	требуется
body	SyntheticLocationUpdate	Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.	body	по желанию

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

Объект `SyntheticLocationUpdate`

Обновление синтетической локации. Фактический объект зависит от типа местоположения.

Элемент	Тип	Описание	Необходимость
type	string	Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: `PUBLIC`-> SyntheticPublicLocationUpdate `PRIVATE`-> PrivateSyntheticLocationUpdate Элемент может содержать эти значения `PRIVATE` `PUBLIC`	требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "type": "PRIVATE",
  "name": "Linz Location",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "93302281"
  ],
  "status": "ENABLED"
}

Пример

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

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

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

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

Curl

<curl -X PUT \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45 \
  -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"
  ]
}
'

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45

Тело запроса

<{
  "type": "PRIVATE",
  "name": "Linz",
  "countryCode": "AT",
  "regionCode": "AU04",
  "city": "Linz",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": ["93302281", "353074222"]
}

Код ответа

204

@@ Строка 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 локация*'''''
 Обновляет существующее частное синтетическое местоположение.
@@ Строка 25: / Строка 27: @@
 |locationId
 |string
-|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
+|Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.
 |path
 |требуется
@@ Строка 71: / Строка 73: @@
     ],
     "status": "ENABLED"
-  }</code>
+  }
 == Ответ ==
@@ Строка 83: / Строка 85: @@
 |locationId
 |string
-|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
+|Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.
 |path
 |требуется
@@ Строка 129: / Строка 131: @@
     ],
     "status": "ENABLED"
-  }</code>
+  }
 == Пример ==
@@ Строка 158: / Строка 160: @@
     ]
   }
-  '</code>
+  '
 ==== URL-адрес запроса ====
@@ Строка 173: / Строка 175: @@
     "longitude": 14.287399,
     "nodes": ["93302281", "353074222"]
-  }</code>
+  }
 ==== Код ответа ====

Текущая версия от 17:06, 2 января 2025

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

Параметры

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

Объект SyntheticLocationUpdate

JSON-модель тела запроса

Ответ

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

Объект SyntheticLocationUpdate

JSON-модель тела запроса

Пример

Curl

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

Тело запроса

Код ответа

Объект `SyntheticLocationUpdate`

Объект `SyntheticLocationUpdate`