POST прочие события - История изменений

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

2025-01-02T17:15:09Z

← Предыдущая версия		Версия от 17:15, 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=GET%20%D0%BD%D0%BE%D0%B4%D0%B0-,%D0%9F%D1%80%D0%BE%D1%87%D0%B0%D1%8F%20%D1%81%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0,-POST%20%D0%BF%D1%80%D0%BE%D1%87%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Прочая синтетика] / POST прочие события'''''

	Передает информацию о сторонних синтетических событиях в АппОптима.		Передает информацию о сторонних синтетических событиях в АппОптима.

Строка 152:		Строка 154:
	}		}
	]		]
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 189:		Строка 191:
	-H 'Content-Type: application/json' \		-H 'Content-Type: application/json' \
	-d '{<truncated - see the Request body section below>}		-d '{<truncated - see the Request body section below>}
	'~~</code>~~		'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 209:		Строка 211:
	],		],
	"resolved": []		"resolved": []
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
Строка 217:		Строка 219:
	Подсветка показывает параметры, представленные в запросе.		Подсветка показывает параметры, представленные в запросе.

	[[Файл:syn3.png]]		[[Файл:syn3.png\|1107x1107пкс]]

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

2024-12-26T09:10:18Z

← Предыдущая версия		Версия от 09:10, 26 декабря 2024
Строка 1:		Строка 1:
	Передает информацию о сторонних синтетических событиях в ~~Ключ-АСТРОМ~~.		Передает информацию о сторонних синтетических событиях в АппОптима.

	Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.		Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/events</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/events</nowiki></code>
	\|-		\|-
Строка 130:		Строка 130:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"syntheticEngineName": "string",		"syntheticEngineName": "string",
	"open": [		"open": [
Строка 177:		Строка 177:

	== Пример ==		== Пример ==
	В этом примере запрос добавляет в пример синтетического монитора событие отключения — 1 сторонний синтетический монитор из ''POST прочие мониторы'' в ~~Ключ-АСТРОМ~~ .		В этом примере запрос добавляет в пример синтетического монитора событие отключения — 1 сторонний синтетический монитор из ''POST прочие мониторы'' в АппОптима .

	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
Строка 184:		Строка 184:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X POST \		<curl -X POST \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/events</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/events</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 195:		Строка 195:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"syntheticEngineName": "My third-party synthetic",		"syntheticEngineName": "My third-party synthetic",
	"open": [		"open": [

ENetrebin в 10:44, 25 октября 2022

2022-10-25T10:44:22Z

← Предыдущая версия		Версия от 10:44, 25 октября 2022
Строка 216:		Строка 216:
	==== Результат ====		==== Результат ====
	Подсветка показывает параметры, представленные в запросе.		Подсветка показывает параметры, представленные в запросе.

			[[Файл:syn3.png]]

ENetrebin: Новая страница: «Передает информацию о сторонних синтетических событиях в Ключ-АСТРОМ. Запрос используе...»

2022-10-25T10:42:12Z

Новая страница: «Передает информацию о сторонних синтетических событиях в Ключ-АСТРОМ. Запрос используе...»

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

Передает информацию о сторонних синтетических событиях в Ключ-АСТРОМ.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|3rdPartySyntheticEvents
|Тело JSON запроса. Содержит сторонние синтетические события.
|body
|требуется
|}

=== Объекты тела запроса ===

==== Объект <code>3rdPartySyntheticEvents</code> ====
Список сторонних синтетических событий.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|syntheticEngineName
|string
|Тип стороннего синтетического монитора.
|требуется
|-
|open
|3rdPartyEventOpenNotification[]
|Список открытых сторонних синтетических событий.
|по желанию
|-
|resolved
|3rdPartyEventResolvedNotification[]
|Список закрытых сторонних синтетических событий.
|по желанию
|}

==== Объект <code>3rdPartyEventOpenNotification</code> ====
Открытое стороннее синтетическое событие.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|testId
|string
|Идентификатор стороннего синтетического монитора.
|требуется
|-
|eventId
|string
|Уникальный идентификатор события.
|требуется
|-
|name
|string
|Название события.
|требуется
|-
|eventType
|string
|Тип события.

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

* <code>testOutage</code>
* <code>testSlowdown</code>
|требуется
|-
|reason
|string
|Причина события.
|требуется
|-
|startTimestamp
|integer
|Отметка времени начала события в миллисекундах UTC.
|требуется
|-
|locationIds
|string[]
|Список идентификаторов сторонних синтетических локаций, где происходит событие.
|требуется
|}

==== Объект <code>3rdPartyEventResolvedNotification</code> ====
Закрытое стороннее синтетическое мероприятие.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|testId
|string
|Идентификатор стороннего синтетического монитора.
|требуется
|-
|eventId
|string
|Уникальный идентификатор события.
|требуется
|-
|endTimestamp
|integer
|Отметка времени окончания события в миллисекундах UTC.
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"syntheticEngineName": "string",
"open": [
{
"testId": "string",
"eventId": "string",
"name": "string",
"eventType": "testOutage",
"reason": "string",
"startTimestamp": 1,
"locationIds": [
"string"
]
}
],
"resolved": [
{
"testId": "string",
"eventId": "string",
"endTimestamp": 1
}
]
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
|
|Успех. Информация принимается и сохраняется.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}

== Обновите существующий сторонний монитор ==
Чтобы обновить существующий сторонний монитор, укажите его движок в поле syntheticEngineName<code>3rdPartySyntheticTests</code> объекта и его ID в поле id<code>3rdPartySyntheticTest</code> объекта.

Вы должны представить все параметры монитора. Не изменяйте значения параметров, которые вы не хотите изменять.

== Пример ==
В этом примере запрос добавляет в пример синтетического монитора событие отключения — 1 сторонний синтетический монитор из ''POST прочие мониторы'' в Ключ-АСТРОМ .

Маркер API передается в заголовке авторизации .

Вы можете загрузить тело запроса в формате JSON, чтобы выполнить образец запроса в своей среде. Обязательно замените временные метки на недавние, иначе результаты будут слишком старыми.

==== Curl ====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/events</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{<truncated - see the Request body section below>}
'</code>

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

==== Тело запроса ====
<code>{
"syntheticEngineName": "My third-party synthetic",
"open": [
{
"testId": "3rdPartySyntheticMonitor1",
"eventId": "extOpenEvent1-1",
"name": "example of event",
"reason": "sample outage",
"eventType": "testOutage",
"locationIds": ["Linz1"],
"startTimestamp": 1543582285957
}
],
"resolved": []
}</code>

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

==== Результат ====
Подсветка показывает параметры, представленные в запросе.