- Частные локации Обновляет существующее местоположение.
- Общественные места Изменяет статус существующей локации .
Запрос использует в качестве полезной нагрузки application/json формат.
| PUT | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись синтетических местоположений ( syntheticLocations.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| locationId | string | Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить. | path | требуется |
| body | SyntheticLocationUpdate | Тело JSON запроса. Содержит обновленные параметры местоположения. | body | по желанию |
Объекты тела запроса
Объект SyntheticLocationUpdate
Синтетическое обновление локации. Это базовый объект, точный тип зависит от значения typeполя.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| type | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"type": "PRIVATE"
}
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Успех. Местоположение обновлено. Ответ не имеет тела. |
Пример — частная локация
В этом примере запрос обновляет приватное синтетическое расположение из примера POST-запроса . Он меняет название местоположения на Linz и добавляет синтетический узел с идентификатором 353074222 .
Маркер API передается в заголовке авторизации .
Код ответа 204 означает, что обновление прошло успешно.
Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса GET для всех узлов .
Curl
<curl -L -X PUT 'https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"regionCode": "04",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"290433380",
"353074222"
],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC
Тело запроса
<{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["290433380", "353074222"],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}
Код ответа
204
Пример - общественное место
В этом примере запрос отключает общедоступное местоположение с идентификатором SYNTHETIC_LOCATION-0000000000000273 .
Маркер API передается в заголовке авторизации .
Код ответа 204 означает, что обновление прошло успешно.
Curl
<curl -L -X PUT 'https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "PUBLIC",
"status": "DISABLED"
}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273
Тело запроса
<{
"type": "PUBLIC",
"status": "DISABLED"
}
Код ответа
204