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

IKuznetsov в 07:44, 7 января 2025

2025-01-07T07:44:49Z

← Предыдущая версия		Версия от 07:44, 7 января 2025
Строка 1:		Строка 1:
			'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима\|REST API]] / [[API Кластера v2]] / [[API Кластера v2\|Лог мониторинга]] / [[Получение свойств указанных локаций (GET локация)]]'''''

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

Строка 101:		Строка 103:
	"status": "DISABLED",		"status": "DISABLED",
	"geoLocationId": "string"		"geoLocationId": "string"
	}~~</code>~~		}
	==Пример (публичная локация)==		==Пример (публичная локация)==
	В этом примере запрос получает сведения об общедоступном расположении Amazon US East (Северная Вирджиния) с идентификатором <code>SYNTHETIC_LOCATION-0000000000000064</code>.		В этом примере запрос получает сведения об общедоступном расположении Amazon US East (Северная Вирджиния) с идентификатором <code>SYNTHETIC_LOCATION-0000000000000064</code>.
Строка 135:		Строка 137:
	],		],
	"geoLocationId": "GEOLOCATION-0A41430434C388A9"		"geoLocationId": "GEOLOCATION-0A41430434C388A9"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>200</code>		<code>200</code>
Строка 162:		Строка 164:
	"locationNodeOutageDelayInMillis": 3000,		"locationNodeOutageDelayInMillis": 3000,
	"geoLocationId": "GEOLOCATION-427705B3488A4C45"		"geoLocationId": "GEOLOCATION-427705B3488A4C45"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>200</code>		<code>200</code>

IKuznetsov в 13:31, 8 ноября 2024

2024-11-08T13:31:31Z

← Предыдущая версия		Версия от 13:31, 8 ноября 2024
Строка 2:		Строка 2:

	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение одной из областей 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>		<code>/api/cluster/v2/synthetic/locations</code>
Строка 90:		Строка 90:

	==== JSON-модель тела ответа ====		==== JSON-модель тела ответа ====
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"type": "CLUSTER",		"type": "CLUSTER",
Строка 109:		Строка 109:
	<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_LOCATION-0000000000000064",		"entityId": "SYNTHETIC_LOCATION-0000000000000064",
	"type": "PUBLIC",		"type": "PUBLIC",
Строка 145:		Строка 145:
	<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",		"entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
	"type": "PRIVATE",		"type": "PRIVATE",

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

2024-08-14T10:32:06Z

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

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

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

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

2022-09-22T15:48:57Z

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

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

Этот вызов 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 Аутентификация кластера].
==Конечная точка==
<code>/api/cluster/v2/synthetic/locations</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|locationId
|string
|Идентификатор объекта требуемого местоположения.
|path
|Да
|}

==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|SyntheticLocation
|Успешно. Ответ содержит параметры синтетического местоположения.
|}
===Объекты тела ответа===
====Объект <code>SyntheticLocation</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта для местоположения.
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code> -> PublicSyntheticLocation
* <code>PRIVATE</code> -> PrivateSyntheticLocation
* <code>CLUSTER</code> -> PrivateSyntheticLocation
|-
|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> только тогда, когда ему не назначен ни один монитор.
|-
|geoLocationId
|string
|Идентификатор местоположения.
|}

==== 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 (Северная Вирджиния) с идентификатором <code>SYNTHETIC_LOCATION-0000000000000064</code>.
====Curl====
<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>
====Код ответа====
<code>200</code>
==Пример (частная локация)==
В этом примере запрос получает сведения о частном расположении HTTP в Линце с идентификатором <code>SYNTHETIC_LOCATION-BB5EE23C1D48AFF5</code>.
====Curl====
<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>
====Код ответа====
<code>200</code>