API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v1 / Синтетические локации / PUT локация*
Обновляет существующее частное синтетическое местоположение.
Запрос потребляет в качестве полезной нагрузкиapplication/json формат.
| PUT | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}
|
| Среда АктивногоШлюза | 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 | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
требуется |
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 | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
требуется |
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