Получение свойств указанных локаций (GET локация): различия между версиями

Текущая версия от 07:44, 7 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Лог мониторинга / Получение свойств указанных локаций (GET локация)

Этот вызов API получает параметры указанного местоположения. Запрос создает полезную нагрузку application/json.

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

Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/synthetic/locations

Параметры

Параметр	Тип	Описание	В	Обязательно
locationId	string	Идентификатор объекта требуемого местоположения.	path	Да

Ответ

Коды ответа

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

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

Объект `SyntheticLocation`

Элемент	Тип	Описание
entityId	string	Идентификатор объекта для местоположения.
type	string	Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation
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` только тогда, когда ему не назначен ни один монитор.
geoLocationId	string	Идентификатор местоположения.

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-0000000000000064.

Curl

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

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

https://mySampleEnv.live.dynatrace.com/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

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

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

https://mySampleEnv.live.dynatrace.com/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: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Лог мониторинга]] / [[Получение свойств указанных локаций (GET локация)]]'''''
 Этот вызов API получает параметры указанного местоположения. Запрос создает полезную нагрузку <code>application/json</code>.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/cluster/v2/synthetic/locations</code>
@@ Строка 63: / Строка 65: @@
 |string
 |Код региона локации.
-Для США или Канады используйте коды штатов ISO 3166-2 (без префикса <code>US</code>- или <code>CA</code>-), например, <code>VA</code> для Вирджинии или <code>OR</code> для Орегона.
-Для остального мира используйте коды FIPS 10-4.
 |-
 |city
@@ Строка 94: / Строка 92: @@
 ==== JSON-модель тела ответа ====
-  <code>{
+  <{
     "entityId": "string",
     "type": "CLUSTER",
@@ Строка 105: / Строка 103: @@
     "status": "DISABLED",
     "geoLocationId": "string"
-  }</code>
+  }
 ==Пример (публичная локация)==
 В этом примере запрос получает сведения об общедоступном расположении Amazon US East (Северная Вирджиния) с идентификатором <code>SYNTHETIC_LOCATION-0000000000000064</code>.
@@ Строка 113: / Строка 111: @@
 <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "entityId": "SYNTHETIC_LOCATION-0000000000000064",
     "type": "PUBLIC",
@@ Строка 139: / Строка 137: @@
     ],
     "geoLocationId": "GEOLOCATION-0A41430434C388A9"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>
@@ Строка 149: / Строка 147: @@
 <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
     "type": "PRIVATE",
@@ Строка 166: / Строка 164: @@
     "locationNodeOutageDelayInMillis": 3000,
     "geoLocationId": "GEOLOCATION-427705B3488A4C45"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>

Текущая версия от 07:44, 7 января 2025

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

Конечная точка

Параметры

Ответ

Коды ответа

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

Объект SyntheticLocation

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

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

Curl

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

Тело ответа

Код ответа

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

Curl

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

Тело ответа

Код ответа

Объект `SyntheticLocation`