Просмотр кода страницы GET локация

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-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>
|}

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

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

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

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|SyntheticLocation
|Успех. Ответ содержит параметры синтетического местоположения.
|}

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

==== Объект <code>SyntheticLocation</code> ====
Конфигурация синтетической локации.

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

Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта Ключ-АСТРОМ для местоположения.
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code>-> PublicSyntheticLocation
* <code>PRIVATE</code>-> PrivateSyntheticLocation
* <code>CLUSTER</code>-> PrivateSyntheticLocation

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

* <code>CLUSTER</code>
* <code>PRIVATE</code>
* <code>PUBLIC</code>
|-
|name
|string
|Название локации.
|-
|countryCode
|string
|Код страны местоположения.

Используйте код alpha-2 стандарта ISO 3166-2 (например, <code>AT</code>для Австрии или <code>PL</code>Польши).
|-
|regionCode
|string
|Код региона локации.

Для США или Канады используйте коды штатов ISO 3166-2 (без префикса <code>US-</code>или <code>CA-</code>), например, <code>VA</code>для Вирджинии или <code>OR</code>Орегона.

Для остального мира используйте коды FIPS 10-4 .
|-
|city
|string
|Город локации.
|-
|latitude
|number
|Широта местоположения в <code>DDD.dddd</code>формате.
|-
|longitude
|number
|Долгота местоположения в <code>DDD.dddd</code>формате.
|-
|status
|string
|Статус локации:

* <code>ENABLED</code>: местоположение отображается как активное в пользовательском интерфейсе. Вы можете назначить мониторы местоположению.
* <code>DISABLED</code>: местоположение отображается как неактивное в пользовательском интерфейсе. Вы не можете назначить мониторы местоположению. Мониторы, уже назначенные местоположению, останутся там и будут выполняться из этого места.
* <code>HIDDEN</code>: местоположение не отображается в пользовательском интерфейсе. Вы не можете назначить мониторы местоположению. Вы можете установить местоположение только тогда, <code>HIDDEN</code>когда ему не назначен ни один монитор.

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

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

=== JSON-модель тела ответа ===
 <code>{
   "entityId": "string",
   "type": "CLUSTER",
   "name": "string",
   "countryCode": "string",
   "regionCode": "string",
   "city": "string",
   "latitude": 1,
   "longitude": 1,
   "status": "DISABLED",
   "geoLocationId": "string"
 }</code>

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

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

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

==== Тело ответа ====
 <code>{
   "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"
 }</code>

==== Код ответа ====
200

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

==== Завиток ====
 <code>curl -X GET \
   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

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

==== Тело ответа ====
 <code>{
   "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"
 }</code>

==== Код ответа ====
200