GET локация - История изменений

IKuznetsov в 17:17, 2 января 2025

2025-01-02T17:17:12Z

← Предыдущая версия		Версия от 17:17, 2 января 2025
Строка 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 локация'''''

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

IKuznetsov в 14:22, 26 декабря 2024

2024-12-26T14:22:40Z

← Предыдущая версия		Версия от 14:22, 26 декабря 2024
Строка 24:		Строка 24:
	\|locationId		\|locationId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого местоположения.		\|Идентификатор объекта АппОптима требуемого местоположения.
	\|path		\|path
	\|требуется		\|требуется
Строка 58:		Строка 58:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ для местоположения.		\|Идентификатор объекта АппОптима для местоположения.
	\|-		\|-
	\|type		\|type
Строка 116:		Строка 116:
	\|geoLocationId		\|geoLocationId
	\|string		\|string
	\|Идентификатор местоположения ~~Ключ-АСТРОМ~~ GeoLocation.		\|Идентификатор местоположения АппОптима GeoLocation.
	\|}		\|}

Строка 131:		Строка 131:
	"status": "DISABLED",		"status": "DISABLED",
	"geoLocationId": "string"		"geoLocationId": "string"
	}~~</code>~~		}

	== Пример - публичная локация ==		== Пример - публичная локация ==
Строка 139:		Строка 139:
	<curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/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-адрес запроса ====		==== URL-адрес запроса ====
Строка 171:		Строка 171:
	],		],
	"geoLocationId": "GEOLOCATION-0A41430434C388A9"		"geoLocationId": "GEOLOCATION-0A41430434C388A9"
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
Строка 182:		Строка 182:
	<curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/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-адрес запроса ====		==== URL-адрес запроса ====
Строка 205:		Строка 205:
	"locationNodeOutageDelayInMillis": 3000,		"locationNodeOutageDelayInMillis": 3000,
	"geoLocationId": "GEOLOCATION-427705B3488A4C45"		"geoLocationId": "GEOLOCATION-427705B3488A4C45"
	}~~</code>~~		}

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

IKuznetsov в 10:26, 26 декабря 2024

2024-12-26T10:26:23Z

← Предыдущая версия		Версия от 10:26, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}</nowiki></code>
	\|-		\|-
Строка 120:		Строка 120:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"type": "CLUSTER",		"type": "CLUSTER",
Строка 137:		Строка 137:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/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'</code>
Строка 145:		Строка 145:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_LOCATION-0000000000000064",		"entityId": "SYNTHETIC_LOCATION-0000000000000064",
	"type": "PUBLIC",		"type": "PUBLIC",
Строка 180:		Строка 180:

	==== Завиток ====		==== Завиток ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/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'</code>
Строка 188:		Строка 188:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",		"entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
	"type": "PRIVATE",		"type": "PRIVATE",

ENetrebin в 10:32, 14 августа 2024

2024-08-14T10:32:38Z

← Предыдущая версия		Версия от 10:32, 14 августа 2024
Строка 87:		Строка 87:
	\|string		\|string
	\|Код региона локации.		\|Код региона локации.

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

	~~Для остального мира используйте коды FIPS 10-4 .~~
	\|-		\|-
	\|city		\|city

ENetrebin в 15:55, 20 октября 2022

2022-10-20T15:55:15Z

Внесённые изменения

ENetrebin: Новая страница: «Получает параметры указанного местоположения. Запрос создает `application/json`полезную...»

2022-10-20T13:47:02Z

Новая страница: «Получает параметры указанного местоположения. Запрос создает <code>application/json</code>полезную...»

Новая страница

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<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>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|идентификатор местоположения
|нить
|Идентификатор объекта Dynatrace требуемого местоположения.
|дорожка
|требуется
|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* <code>DISABLED</code>
* <code>ENABLED</code>
* <code>HIDDEN</code>
|-
|идентификатор геолокации
|нить
|Идентификатор местоположения Dynatrace 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 .

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

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/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.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/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