JSON модели

Материал из Документация Ключ-АСТРОМ

Некоторые JSON-модели API синтетических местоположений различаются в зависимости от его типа . Здесь вы можете найти модели JSON для каждого варианта.

Вариации SyntheticLocationобъекта

Объект SyntheticLocationявляется базой для синтетических локаций. Фактический набор полей зависит от типа местоположения.

КЛАСТЕРНЫЕ и ЧАСТНЫЕ

PrivateSyntheticLocation

Параметры:

Объект PrivateSyntheticLocation

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

Параметры 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 модель:

{
  "entityId": "SYNTHETIC_LOCATION-F23EE93163E76BE2",
  "type": "PRIVATE",
  "status": "ENABLED",
  "name": "Sample synthetic location",
  "countryCode": "PL",
  "regionCode": "82",
  "city": "Gdańsk",
  "latitude": 54.389,
  "longitude": 18.6255,
  "nodes": [
    "2131628184"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000,
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}

ОБЩЕСТВЕННЫЕ

PublicSyntheticLocation

Параметры:

Объект PublicSyntheticLocation

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

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

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

Элемент Тип Описание
cloudPlatform string Облачный провайдер, у которого размещено местоположение.

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

  • ALIBABA
  • AMAZON_EC2
  • AZURE
  • ASTROMKEY_CLOUD
  • GOOGLE_CLOUD
  • INTEROUTE
  • OTHER
  • UNDEFINED
ips string[] Список IP-адресов, присвоенных местоположению.
stage string Этап локации.

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

  • BETA
  • COMING_SOON
  • DELETED
  • GA
browserType string Тип браузера, который местоположение использует для запуска мониторов браузера.
browserVersion string Версия браузера, которую местоположение использует для запуска мониторов браузера.
capabilities string[] Список возможностей местоположения.

JSON модель:

{
  "name": "US Central",
  "entityId": "SYNTHETIC_LOCATION-00000000000001A5",
  "type": "PUBLIC",
  "cloudPlatform": "GOOGLE_CLOUD",
  "ips": [
    "210.6.226.150",
    "185.77.153.103",
    "153.242.5.43"
  ],
  "stage": "BETA",
  "status": "ENABLED",
  "capabilities": [
    "BROWSER",
    "HTTP"
  ],
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}