POST локация

Материал из Документация Ключ-АСТРОМ
Версия от 16:08, 20 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного синтетического местоположения .

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

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations

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

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

Параметр

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

Параметр Тип Описание In Необходимость
body SyntheticLocation Тело JSON запроса. Содержит параметры новой частной синтетической локации. body по желанию

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

Объект SyntheticLocation

Конфигурация синтетической локации.

Параметры countryCode , regionCode , city являются необязательными, поскольку их можно получить на основе широты и долготы местоположения.

Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .

Элемент Тип Описание Необходимость
nodes string[] Список синтетических узлов, принадлежащих локации.

Вы можете получить список доступных узлов с помощью вызова GET all nodes .

по желанию
availabilityLocationOutage boolean Предупреждение об отключении местоположения включено ( true) или отключено ( false). по желанию
availabilityNodeOutage boolean Оповещение об отключении узла включено ( true) или отключено ( false).

Если включено, сбой любого узла в локации вызывает оповещение.

по желанию
locationNodeOutageDelayInMinutes integer Оповещение, если сбой местоположения или узла длится дольше X минут.

Применимо только в том случае, если для параметраavailabilityLocationOutage или availabilityNodeOutage задано значение .true

по желанию
availabilityNotificationsEnabled boolean Уведомления о сбое местоположения и узла включены ( true) или отключены ( false). по желанию
deploymentType string Тип развертывания местоположения:
  • STANDARD: расположение развернуто в Windows или Linux.
  • KUBERNETES: расположение развернуто в Kubernetes.

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

  • KUBERNETES
  • STANDARD
по желанию
autoUpdateChromium boolean Автоматическое обновление Chromium включено ( true) или отключено ( false). по желанию

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

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

{
  "nodes": [
    "string"
  ],
  "availabilityLocationOutage": true,
  "availabilityNodeOutage": true,
  "locationNodeOutageDelayInMinutes": 1,
  "availabilityNotificationsEnabled": true,
  "deploymentType": "KUBERNETES",
  "autoUpdateChromium": true
}

Ответ

Коды ответов

Код Тип Описание
201 SyntheticLocationIdsDto Успех. Частная локация создана. Ответ содержит идентификатор нового местоположения.

Объекты тела ответа

Объект SyntheticLocationIdsDto

DTO для синтетических идентификаторов местоположения.

Элемент Тип Описание
entityId string Идентификатор объекта для передачи
geoLocationId string Идентификатор геолокации для передачи

JSON-модель тела ответа

{
  "entityId": "string",
  "geoLocationId": "string"
}

Пример

В этом примере запрос создает новое частное синтетическое местоположение. Это место находится в Линце, Австрия . Он использует синтетический узел с идентификатором 290433380 .

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

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса GET для всех узлов .

Curl

curl -L -X POST 'https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
  "type": "PRIVATE",
  "name": "REST example - Linz",
  "countryCode": "AT",
  "city": "Linz",
  "status": "ENABLED",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "290433380"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000
}
'

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

https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations

Тело запроса

{
  "type": "PRIVATE",
  "name": "REST example - Linz",
  "countryCode": "AT",
  "city": "Linz",
  "status": "ENABLED",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": ["290433380"],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000
}

Тело ответа

{
  "entityId": "SYNTHETIC_LOCATION-493122BFA29674DC",
  "geoLocationId": "GEOLOCATION-96B57899C9B5A3C7"
}

Код ответа

200