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

Материал из Dynatrace
(Новая страница: «* ''Частные локации'' Обновляет существующее местоположение. * ''Общественные места'' Изме...»)
 
 
Строка 9: Строка 9:
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
|-
|-
|Среда АктивногоШлюза
|Среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
|}
|}
Строка 27: Строка 27:
|locationId
|locationId
|string
|string
|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
|Идентификатор объекта Dynatrace синтетического местоположения, которое необходимо обновить.
|path
|path
|требуется
|требуется
Строка 89: Строка 89:


==== Curl ====
==== Curl ====
  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -H 'Content-Type: application/json' \
Строка 112: Строка 112:


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC</nowiki></code>


==== Тело запроса ====
==== Тело запроса ====
Строка 140: Строка 140:


==== Curl ====
==== Curl ====
  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273'</nowiki> \
  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273'</nowiki> \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -H 'Content-Type: application/json' \
Строка 150: Строка 150:


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273</nowiki></code>


==== Тело запроса ====
==== Тело запроса ====

Текущая версия на 15:48, 13 февраля 2023

  • Частные локации Обновляет существующее местоположение.
  • Общественные места Изменяет статус существующей локации.

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

PUT Managed https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}
Среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}

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

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

Параметры

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

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

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

Объект SyntheticLocationUpdate

Синтетическое обновление локации. Это базовый объект, точный тип зависит от значения typeполя.

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

Элемент может содержать эти значения

  • PRIVATE
  • PUBLIC
требуется

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

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

{
  "type": "PRIVATE"
}

Ответ

Коды ответов

Код Описание
204 Успех. Местоположение обновлено. Ответ не имеет тела.

Пример — частная локация

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

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

Код ответа 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 передается в заголовке авторизации .

Код ответа 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