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

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

2025-01-02T17:05:29Z

← Предыдущая версия		Версия от 17:05, 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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%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%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [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=JSON%20%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8-,%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:38, 26 декабря 2024

2024-12-26T14:38:14Z

← Предыдущая версия		Версия от 14:38, 26 декабря 2024
Строка 24:		Строка 24:
	\|locationId		\|locationId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого местоположения.		\|Идентификатор объекта АппОптима требуемого местоположения.
	\|path		\|path
	\|требуется		\|требуется
Строка 58:		Строка 58:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ для местоположения.		\|Идентификатор объекта АппОптима для местоположения.
	\|-		\|-
	\|type		\|type
Строка 130:		Строка 130:
	"longitude": 1,		"longitude": 1,
	"status": "DISABLED"		"status": "DISABLED"
	}~~</code>~~		}

	== Пример - общественное место ==		== Пример - общественное место ==
Строка 138:		Строка 138:
	<curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 159:		Строка 159:
	"134.189.153.99"		"134.189.153.99"
	]		]
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
Строка 170:		Строка 170:
	<curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 189:		Строка 189:
	"3086117876"		"3086117876"
	]		]
	}~~</code>~~		}

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

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

2024-12-26T10:27:26Z

← Предыдущая версия		Версия от 10:27, 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/v1/synthetic/locations/{locationId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
	\|-		\|-
Строка 120:		Строка 120:

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

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 144:		Строка 144:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "GEOLOCATION-95196F3C9A4F4215",		"entityId": "GEOLOCATION-95196F3C9A4F4215",
	"type": "PUBLIC",		"type": "PUBLIC",
Строка 168:		Строка 168:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 176:		Строка 176:

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

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

2022-10-24T14:38:45Z

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

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

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

Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}</nowiki></code>
|}

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

== Параметры ==
{| 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>
|}

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

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

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

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215</nowiki></code>

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

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

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

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

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

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

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