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

Текущая версия от 15:39, 26 декабря 2024

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

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

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

PUT	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}`
PUT	Среда АктивногоШлюза	`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	Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: `PUBLIC`-> SyntheticPublicLocationUpdate `PRIVATE`-> SyntheticPrivateLocationUpdate Элемент может содержать эти значения `PRIVATE` `PUBLIC`	требуется

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

@@ Строка 1: / Строка 1: @@
 * ''Частные локации'' Обновляет существующее местоположение.
-* ''Общественные места'' Изменяет статус существующей локации.
+* ''Общественные места'' Изменяет статус существующей локации .
 Запрос использует в качестве полезной нагрузки  <code>application/json</code> формат.
 {| class="wikitable"
 | rowspan="2" |PUT
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
 |-
@@ Строка 27: / Строка 27: @@
 |locationId
 |string
-|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
+|Идентификатор объекта АппОптима синтетического местоположения, которое необходимо обновить.
 |path
 |требуется
@@ Строка 64: / Строка 64: @@
 === JSON-модель тела запроса ===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "type": "PRIVATE"
-  }</code>
+  }
 == Ответ ==
@@ Строка 89: / Строка 89: @@
 ==== Curl ====
-  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
+  <curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   -H 'Content-Type: application/json' \
@@ Строка 109: / Строка 109: @@
     "locationNodeOutageDelayInMillis": 5000
   }
-  '</code>
+  '
 ==== URL-адрес запроса ====
@@ Строка 115: / Строка 115: @@
 ==== Тело запроса ====
-  <code>{
+  <{
     "type": "PRIVATE",
     "name": "Linz",
@@ Строка 127: / Строка 127: @@
     "availabilityNodeOutage": false,
     "locationNodeOutageDelayInMillis": 5000
-  }</code>
+  }
 ==== Код ответа ====
@@ Строка 140: / Строка 140: @@
 ==== Curl ====
-  <code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273'</nowiki> \
+  <curl -L -X PUT '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273'</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   -H 'Content-Type: application/json' \
@@ Строка 147: / Строка 147: @@
     "status": "DISABLED"
   }
-  '</code>
+  '
 ==== URL-адрес запроса ====
@@ Строка 153: / Строка 153: @@
 ==== Тело запроса ====
-  <code>{
+  <{
     "type": "PUBLIC",
     "status": "DISABLED"
-  }</code>
+  }
 ==== Код ответа ====

Текущая версия от 15:39, 26 декабря 2024

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

Параметры

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

Объект SyntheticLocationUpdate

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

Ответ

Коды ответов

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

Curl

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

Тело запроса

Код ответа

Пример - общественное место

Curl

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

Тело запроса

Код ответа

Объект `SyntheticLocationUpdate`