GET локация: различия между версиями

Текущая версия от 17:17, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v2 / Синтетические локации / GET локация

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

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}`
GET	Среда АктивногоШлюза	`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

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D1%8F%20%D0%BF%D1%80%D0%BE%D1%87%D0%B8%D1%85%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%BE%D0%B2-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v2,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетика v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v2-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетические локации] / GET локация'''''
 Получает параметры указанного местоположения.
-Запрос создает <code>application/json</code>полезную нагрузку.
+Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="2" |GET
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
 |-
-|SaaS
+|Среда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/{locationId}</nowiki></code>
-|-
-|Окружающая среда ActiveGate
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
 |}
@@ Строка 22: / Строка 21: @@
 !Тип
 !Описание
-!В
+!In
-!Необходимый
+!Необходимость
 |-
-|идентификатор местоположения
+|locationId
-|нить
+|string
-|Идентификатор объекта Dynatrace требуемого местоположения.
+|Идентификатор объекта АппОптима требуемого местоположения.
-|дорожка
+|path
 |требуется
 |}
@@ Строка 42: / Строка 41: @@
 |-
 |200
-|Синтетическое местоположение
+|SyntheticLocation
 |Успех. Ответ содержит параметры синтетического местоположения.
 |}
@@ Строка 48: / Строка 47: @@
 === Объекты тела ответа ===
-==== Объект _ <code>SyntheticLocation</code> ====
+==== Объект <code>SyntheticLocation</code> ====
 Конфигурация синтетической локации.
@@ Строка 59: / Строка 58: @@
 !Описание
 |-
-|идентификатор сущности
+|entityId
-|нить
+|string
-|Идентификатор объекта Dynatrace для местоположения.
+|Идентификатор объекта АппОптима для местоположения.
 |-
-|тип
+|type
-|нить
+|string
 |Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:
@@ Строка 77: / Строка 76: @@
 * <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
 |Статус локации:
@@ Строка 121: / Строка 116: @@
 * <code>HIDDEN</code>
 |-
-|идентификатор геолокации
+|geoLocationId
-|нить
+|string
-|Идентификатор местоположения Dynatrace GeoLocation.
+|Идентификатор местоположения АппОптима GeoLocation.
 |}
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "entityId": "string",
     "type": "CLUSTER",
@@ Строка 138: / Строка 133: @@
     "status": "DISABLED",
     "geoLocationId": "string"
-  }</code>
+  }
-== Пример - общественное место ==
+== Пример - публичная локация ==
 В этом примере запрос получает сведения об общедоступном расположении Amazon US East (Северная Вирджиния) с идентификатором SYNTHETIC_LOCATION-00000000000000064 .
-==== Завиток ====
+==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
-    <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki> \
+    <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
-  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki></code>
 ==== Тело ответа ====
-  <code>{
+  <{
     "entityId": "SYNTHETIC_LOCATION-0000000000000064",
     "type": "PUBLIC",
@@ Строка 178: / Строка 173: @@
     ],
     "geoLocationId": "GEOLOCATION-0A41430434C388A9"
-  }</code>
+  }
 ==== Код ответа ====
@@ Строка 187: / Строка 182: @@
 ==== Завиток ====
-  <code>curl -X GET \
+  <curl -X GET \
-    <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki> \
+    <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
-  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki></code>
 ==== Тело ответа ====
-  <code>{
+  <{
     "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
     "type": "PRIVATE",
@@ Строка 212: / Строка 207: @@
     "locationNodeOutageDelayInMillis": 3000,
     "geoLocationId": "GEOLOCATION-427705B3488A4C45"
-  }</code>
+  }
 ==== Код ответа ====

Текущая версия от 17:17, 2 января 2025

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

Параметры

Ответ

Коды ответов

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

Объект SyntheticLocation

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

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

Curl

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

Тело ответа

Код ответа

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

Завиток

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

Тело ответа

Код ответа

Объект `SyntheticLocation`