Обновление частной синтетической локации (PUT локация) - История изменений

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

2025-01-07T07:46:45Z

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

	Этот вызов API:		Этот вызов API:

Строка 51:		Строка 53:
	<{		<{
	"type": "PRIVATE"		"type": "PRIVATE"
	}~~</code>~~		}

	==Ответ==		==Ответ==
Строка 107:		Строка 109:
	"availabilityNodeOutage": false,		"availabilityNodeOutage": false,
	"locationNodeOutageDelayInMillis": 5000		"locationNodeOutageDelayInMillis": 5000
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>204</code>		<code>204</code>
Строка 132:		Строка 134:
	"type": "PUBLIC",		"type": "PUBLIC",
	"status": "DISABLED"		"status": "DISABLED"
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	<code>204</code>		<code>204</code>

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

2024-11-08T13:32:48Z

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

	==Аутентификация==		==Аутентификация==
	Для выполнения этого запроса вам необходимо разрешение одной из областей 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>
Строка 32:		Строка 32:
	===Объекты тела запроса===		===Объекты тела запроса===
	====Объект <code>SyntheticLocationUpdate</code>====		====Объект <code>SyntheticLocationUpdate</code>====
	Конфигурация синтетической локации. Реальный набор полей зависит от типа локации. Найдите список актуальных объектов в описании поля типа или см. [https://doc.ruscomtech.ru/index.php/%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_%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8_API_v2_%E2%80%94_%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8_JSON Синтетические локации API v2 — модели JSON].		Конфигурация синтетической локации. Реальный набор полей зависит от типа локации. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 49:		Строка 49:

	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	<~~code>~~{		<{
	"type": "PRIVATE"		"type": "PRIVATE"
	}</code>		}</code>
Строка 69:		Строка 69:
	Код ответа '''204''' означает, что обновление прошло успешно.		Код ответа '''204''' означает, что обновление прошло успешно.

	Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса [https://doc.ruscomtech.ru/index.php/%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%B2%D1%81%D0%B5%D1%85_%D1%81%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D1%85_%D0%BD%D0%BE%D0%B4_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_(~~GET_%D0%B2%D1%81%D0%B5_%D0%BD%D0%BE%D0%B4%D1%8B~~) GET для всех узлов].		Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса [[Получение всех синтетических нод кластера (GET все ноды)\|GET для всех узлов]].
	====Curl====		====Curl====
	<code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \		<code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
Строка 95:		Строка 95:
	<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"type": "PRIVATE",		"type": "PRIVATE",
	"name": "Linz",		"name": "Linz",
Строка 129:		Строка 129:
	<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"type": "PUBLIC",		"type": "PUBLIC",
	"status": "DISABLED"		"status": "DISABLED"

RGolovanov в 14:41, 23 сентября 2022

2022-09-23T14:41:32Z

← Предыдущая версия		Версия от 14:41, 23 сентября 2022
Строка 60:		Строка 60:
	\|-		\|-
	\|'''204'''		\|'''204'''
	\|Успех. ~~Местоположение обновлено~~. Ответ не имеет тела.		\|Успех. Локация обновлена. Ответ не имеет тела.
	\|}		\|}
	==Пример (частная локация)==		==Пример (частная локация)==
	В этом примере запрос обновляет частное синтетическое расположение из примера запроса POST. Он меняет название местоположения на Linz и добавляет синтетический узел с идентификатором '''353074222'''. ~~Токен~~		В этом примере запрос обновляет частное синтетическое расположение из примера запроса POST. Он меняет название местоположения на Linz и добавляет синтетический узел с идентификатором '''353074222'''.

	API передается в заголовке '''Authorization'''.		Токен API передается в заголовке '''Authorization'''.

	Код ответа '''204''' означает, что обновление прошло успешно.		Код ответа '''204''' означает, что обновление прошло успешно.

RGolovanov: Новая страница: «Этот вызов API: * Частные местоположения: обновляет локацию. * Публичные локации: Изменяет...»

2022-09-22T17:09:06Z

Новая страница: «Этот вызов 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
|Да
|-
|body
|SyntheticLocationUpdate
|Тело JSON запроса. Содержит обновленные параметры локации.
|body
|Нет
|}
===Объекты тела запроса===
====Объект <code>SyntheticLocationUpdate</code>====
Конфигурация синтетической локации. Реальный набор полей зависит от типа локации. Найдите список актуальных объектов в описании поля типа или см. [https://doc.ruscomtech.ru/index.php/%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_%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8_API_v2_%E2%80%94_%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8_JSON Синтетические локации API v2 — модели JSON].
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code> -> SyntheticPublicLocationUpdate
* <code>PRIVATE</code> -> SyntheticPrivateLocationUpdate
|Да
|}

=== JSON-модель тела запроса ===
<code>{
"type": "PRIVATE"
}</code>

==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Описание
|-
|'''204'''
|Успех. Местоположение обновлено. Ответ не имеет тела.
|}
==Пример (частная локация)==
В этом примере запрос обновляет частное синтетическое расположение из примера запроса POST. Он меняет название местоположения на Linz и добавляет синтетический узел с идентификатором '''353074222'''. Токен

API передается в заголовке '''Authorization'''.

Код ответа '''204''' означает, что обновление прошло успешно.

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде. Вы можете получить список доступных узлов с помощью запроса [https://doc.ruscomtech.ru/index.php/%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%B2%D1%81%D0%B5%D1%85_%D1%81%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D1%85_%D0%BD%D0%BE%D0%B4_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_(GET_%D0%B2%D1%81%D0%B5_%D0%BD%D0%BE%D0%B4%D1%8B) GET для всех узлов].
====Curl====
<code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"regionCode": "04",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"290433380",
"353074222"
],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}
'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC</nowiki></code>
====Тело запроса====
<code>{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"city": "Linz",
"status": "ENABLED",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["290433380", "353074222"],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 5000
}</code>
====Код ответа====
<code>204</code>
==Пример (публичная локация)==
В этом примере запрос отключает общедоступное местоположение с идентификатором <code>SYNTHETIC_LOCATION-0000000000000273</code>.

Токен API передается в заголовке '''Authorization'''.

Код ответа <code>204</code> означает, что обновление прошло успешно.

====Curl====
<code>curl -L -X PUT '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "PUBLIC",
"status": "DISABLED"
}
'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273</nowiki></code>
====Тело запроса====
<code>{
"type": "PUBLIC",
"status": "DISABLED"
}</code>
====Код ответа====
<code>204</code>