GET локация*
Получает параметры указанного местоположения.
Запрос создает в качестве полезной нагрузкиapplication/json
формат.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
locationId | string | Идентификатор объекта Ключ-АСТРОМ требуемого местоположения. | path | требуется |
Ответ
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | SyntheticLocation | Успех. Ответ содержит параметры синтетического местоположения. |
Объекты тела ответа
Объект SyntheticLocation
Конфигурация синтетической локации.
Параметры countryCode , regionCode , city являются необязательными, поскольку их можно получить на основе широты и долготы местоположения.
Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .
Элемент | Тип | Описание |
---|---|---|
entityId | string | Идентификатор объекта Ключ-АСТРОМ для местоположения. |
type | string | Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
Элемент может содержать эти значения
|
name | string | Название локации. |
countryCode | string | Код страны местоположения.
Используйте код alpha-2 стандарта ISO 3166-2 (например, |
regionCode | string | Код региона локации.
Для США или Канады используйте коды штатов ISO 3166-2 (без префикса Для остального мира используйте коды FIPS 10-4 . |
city | string | Город локации. |
latitude | number | Широта местоположения в DDD.dddd формате.
|
longitude | number | Долгота местоположения в DDD.dddd формате.
|
status | string | Статус локации:
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"entityId": "string",
"type": "CLUSTER",
"name": "string",
"countryCode": "string",
"regionCode": "string",
"city": "string",
"latitude": 1,
"longitude": 1,
"status": "DISABLED"
}
Пример - общественное место
В этом примере запрос получает сведения об общедоступном местоположении Amazon US East (Северная Вирджиния) с идентификатором GEOLOCATION-95196F3C9A4F4215 .
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215
Тело ответа
{
"entityId": "GEOLOCATION-95196F3C9A4F4215",
"type": "PUBLIC",
"name": "Amazon US East (N. Virginia)",
"countryCode": "US",
"regionCode": "VA",
"city": "Amazon US East (N. Virginia)",
"latitude": 39.0436,
"longitude": -77.4875,
"cloudPlatform": "AMAZON_EC2",
"ips": [
"134.189.153.97",
"134.189.153.98",
"134.189.153.99"
]
}
Код ответа
200
Пример — частная локация
В этом примере запрос получает сведения о частном HTTP - местоположении в Гданьске с идентификатором SYNTHETIC_LOCATION-95196F3C9A4F4215 .
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215
Тело ответа
{
"entityId": "SYNTHETIC_LOCATION-9C75B59442498323",
"type": "PRIVATE",
"name": "Gdansk HTTP",
"countryCode": "PL",
"regionCode": "82",
"city": "Gdańsk",
"latitude": 54.3449,
"longitude": 18.6283,
"nodes": [
"2015649819",
"3086117876"
]
}
Код ответа
200