GET локация

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

Получает параметры указанного местоположения.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
locationId string Идентификатор объекта Ключ-АСТРОМ требуемого местоположения. path требуется

Ответ

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

Коды ответов

Код Тип Описание
200 SyntheticLocation Успех. Ответ содержит параметры синтетического местоположения.

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

Объект SyntheticLocation

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

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

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

Элемент Тип Описание
entityId string Идентификатор объекта Ключ-АСТРОМ для местоположения.
type string Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
  • PUBLIC-> PublicSyntheticLocation
  • PRIVATE-> PrivateSyntheticLocation
  • CLUSTER-> PrivateSyntheticLocation

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

  • CLUSTER
  • PRIVATE
  • PUBLIC
name string Название локации.
countryCode string Код страны местоположения.

Используйте код alpha-2 стандарта ISO 3166-2 (например, ATдля Австрии или PLПольши).

regionCode string Код региона локации.
city string Город локации.
latitude number Широта местоположения в DDD.ddddформате.
longitude number Долгота местоположения в DDD.ddddформате.
status string Статус локации:
  • ENABLED: местоположение отображается как активное в пользовательском интерфейсе. Вы можете назначить мониторы местоположению.
  • DISABLED: местоположение отображается как неактивное в пользовательском интерфейсе. Вы не можете назначить мониторы местоположению. Мониторы, уже назначенные местоположению, останутся там и будут выполняться из этого места.
  • HIDDEN: местоположение не отображается в пользовательском интерфейсе. Вы не можете назначить мониторы местоположению. Вы можете установить местоположение только тогда, HIDDENкогда ему не назначен ни один монитор.

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

  • DISABLED
  • ENABLED
  • HIDDEN
geoLocationId string Идентификатор местоположения Ключ-АСТРОМ GeoLocation.

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

{
  "entityId": "string",
  "type": "CLUSTER",
  "name": "string",
  "countryCode": "string",
  "regionCode": "string",
  "city": "string",
  "latitude": 1,
  "longitude": 1,
  "status": "DISABLED",
  "geoLocationId": "string"
}

Пример - публичная локация

В этом примере запрос получает сведения об общедоступном расположении Amazon US East (Северная Вирджиния) с идентификатором SYNTHETIC_LOCATION-00000000000000064 .

Curl

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

Тело ответа

{
  "entityId": "SYNTHETIC_LOCATION-0000000000000064",
  "type": "PUBLIC",
  "name": "Gdańsk",
  "countryCode": "PL",
  "regionCode": "EU",
  "city": "Gdańsk",
  "latitude": 54.399078,
  "longitude": 18.576557,
  "status": "ENABLED",
  "cloudPlatform": "OTHER",
  "ips": [
    "120.157.221.247",
    "172.158.6.93",
    "197.136.70.30",
    "227.53.205.237",
    "131.123.197.12"
  ],
  "stage": "GA",
  "browserType": "Chrome",
  "browserVersion": "83.0.4103.61",
  "capabilities": [
    "BROWSER",
    "HTTP"
  ],
  "geoLocationId": "GEOLOCATION-0A41430434C388A9"
}

Код ответа

200

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

В этом примере запрос получает сведения о частном расположении HTTP в Линце с идентификатором SYNTHETIC_LOCATION-BB5EE23C1D48AFF5 .

Завиток

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

Тело ответа

{
  "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
  "type": "PRIVATE",
  "name": "Linz HTTP",
  "countryCode": "AT",
  "regionCode": "04",
  "city": "Linz",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "status": "ENABLED",
  "nodes": [
    "137829320"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 3000,
  "geoLocationId": "GEOLOCATION-427705B3488A4C45"
}

Код ответа

200