Этот вызов API:
- Частные местоположения: обновляет локацию.
- Публичные локации: Изменяет статус локации.
Запрос использует полезную нагрузку application/json.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/synthetic/locations
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| locationId | string | Идентификатор синтетической локации, которую необходимо обновить. | path | Да |
| body | SyntheticLocationUpdate | Тело JSON запроса. Содержит обновленные параметры локации. | body | Нет |
Объекты тела запроса
Объект SyntheticLocationUpdate
Конфигурация синтетической локации. Реальный набор полей зависит от типа локации. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON.
| Элемент | Тип | Описание | Обязательно |
|---|---|---|---|
| type | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
|
Да |
JSON-модель тела запроса
<{
"type": "PRIVATE"
}
Ответ
Коды ответа
| Код | Описание |
|---|---|
| 204 | Успех. Локация обновлена. Ответ не имеет тела. |
Пример (частная локация)
В этом примере запрос обновляет частное синтетическое расположение из примера запроса POST. Он меняет название местоположения на Linz и добавляет синтетический узел с идентификатором 353074222.
Токен API передается в заголовке Authorization.
Код ответа 204 означает, что обновление прошло успешно.
Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса GET для всех узлов.
Curl
curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/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.dynatrace.com/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 передается в заголовке Authorization.
Код ответа 204 означает, что обновление прошло успешно.
Curl
curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/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.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273
Тело запроса
<{
"type": "PUBLIC",
"status": "DISABLED"
}
Код ответа
204