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

IKuznetsov в 14:18, 24 декабря 2024

2024-12-24T14:18:30Z

← Предыдущая версия		Версия от 14:18, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [~~[API АппОптима~~#:~:text=DELETE ~~тегов~~-,~~Развёртывание~~,-~~править\|~~Развёртывание]] / [~~[API АппОптима~~#:~:text=~~развертывания из Jenkins~~-,~~События v2~~,-GET ~~списка событий\|~~События v2]] / POST события v2'''''		'''''[[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%80%D0%B0%D0%B7%D0%B2%D0%B5%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B8%D0%B7%20Jenkins-,%D0%A1%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F%20v2,-GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9 События v2] / POST события v2'''''

	Принимает пользовательское событие в АппОптима.		Принимает пользовательское событие в АппОптима.
Строка 104:		Строка 104:
	"entitySelector": "string",		"entitySelector": "string",
	"properties": {}		"properties": {}
	}~~</code>~~		}
	==Ответ==		==Ответ==
	===Коды ответов===		===Коды ответов===
Строка 165:		Строка 165:
	}		}
	]		]
	}~~</code>~~		}
	==Примеры==		==Примеры==
	===Пример 1===		===Пример 1===
Строка 184:		Строка 184:
	"job.number": "21234346"		"job.number": "21234346"
	}		}
	}'~~</code>~~		}'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
Строка 195:		Строка 195:
	"job.number": "21234346"		"job.number": "21234346"
	}		}
	}~~</code>~~		}
	====Тело ответа====		====Тело ответа====
	<{		<{
Строка 209:		Строка 209:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	201		201
Строка 230:		Строка 230:
	"Load pattern": "production"		"Load pattern": "production"
	}		}
	}'~~</code>~~		}'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
Строка 244:		Строка 244:
	"Load pattern": "production"		"Load pattern": "production"
	}		}
	}~~</code>~~		}
	====Тело ответа====		====Тело ответа====
	<{		<{
Строка 254:		Строка 254:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	201		201
Строка 275:		Строка 275:
	"Batch processor": "travel-catalog"		"Batch processor": "travel-catalog"
	}		}
	}'~~</code>~~		}'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
Строка 289:		Строка 289:
	"Batch processor": "travel-catalog"		"Batch processor": "travel-catalog"
	}		}
	}~~</code>~~		}
	====Тело ответа====		====Тело ответа====
	<{		<{
Строка 299:		Строка 299:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	201		201

IKuznetsov в 12:40, 24 декабря 2024

2024-12-24T12:40:51Z

← Предыдущая версия		Версия от 12:40, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / [[API ~~Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B~~\|Эндпойнты среды]] / [[API ~~Ключ~~-~~АСТРОМ#.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~~\|Развёртывание]] / События v2 / POST события v2'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править\|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий\|События v2]] / POST события v2'''''

	Принимает пользовательское событие в ~~Ключ-АСТРОМ~~.		Принимает пользовательское событие в АппОптима.

	Запрос создает <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/v2/events/ingest</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
	\|-		\|-
Строка 78:		Строка 78:
	\|entitySelector		\|entitySelector
	\|string		\|string
	\|Селектор сущностей , определяющий набор сущностей ~~Ключ-АСТРОМ~~, которые будут связаны с событием.		\|Селектор сущностей , определяющий набор сущностей АппОптима, которые будут связаны с событием.
	Можно выбрать только объекты, которые были активны в течение последних 24 часов.		Можно выбрать только объекты, которые были активны в течение последних 24 часов.

Строка 88:		Строка 88:
	\|object		\|object
	\|Карта свойств события.		\|Карта свойств события.
	Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте ~~Ключ-АСТРОМ~~. Все остальные ключи интерпретируются как определяемые пользователем свойства события.		Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте АппОптима. Все остальные ключи интерпретируются как определяемые пользователем свойства события.

	Значения зарезервированных ~~Ключ-АСТРОМ~~ свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.		Значения зарезервированных АппОптима свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.

	Может быть <code>null</code>.		Может быть <code>null</code>.
Строка 96:		Строка 96:
	===JSON-модель тела запроса===		===JSON-модель тела запроса===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"eventType": "AVAILABILITY_EVENT",		"eventType": "AVAILABILITY_EVENT",
	"title": "string",		"title": "string",
Строка 157:		Строка 157:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"reportCount": 1,		"reportCount": 1,
	"eventIngestResults": [		"eventIngestResults": [
Строка 174:		Строка 174:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl --request POST \		<curl --request POST \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \		--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 188:		Строка 188:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"eventType": "MARKED_FOR_TERMINATION",		"eventType": "MARKED_FOR_TERMINATION",
	"title": "Planned host downscale",		"title": "Planned host downscale",
Строка 197:		Строка 197:
	}</code>		}</code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"reportCount": 2,		"reportCount": 2,
	"eventIngestResults": [		"eventIngestResults": [
Строка 217:		Строка 217:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl --request POST \		<curl --request POST \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \		--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 234:		Строка 234:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"eventType": "CUSTOM_INFO",		"eventType": "CUSTOM_INFO",
	"title": "Loadtest start",		"title": "Loadtest start",
Строка 246:		Строка 246:
	}</code>		}</code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"reportCount": 1,		"reportCount": 1,
	"eventIngestResults": [		"eventIngestResults": [
Строка 262:		Строка 262:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl --request POST \		<curl --request POST \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \		--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 279:		Строка 279:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"eventType": "ERROR_EVENT",		"eventType": "ERROR_EVENT",
	"title": "Product catalog update failed",		"title": "Product catalog update failed",
Строка 291:		Строка 291:
	}</code>		}</code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"reportCount": 1,		"reportCount": 1,
	"eventIngestResults": [		"eventIngestResults": [

ENetrebin в 16:25, 17 июня 2024

2024-06-17T16:25:06Z

← Предыдущая версия		Версия от 16:25, 17 июня 2024
Строка 1:		Строка 1:
			'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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\|Развёртывание]] / События v2 / POST события v2'''''

	Принимает пользовательское событие в Ключ-АСТРОМ.		Принимает пользовательское событие в Ключ-АСТРОМ.

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

2024-06-16T18:27:51Z

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

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

Принимает пользовательское событие в Ключ-АСТРОМ.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
|-
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/ingest</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью событий Ingest ( <code>events.ingest</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|EventIngest
|Тело JSON запроса. Содержит свойства нового события.
|body
|необязательный
|}
===Объекты тела запроса===
====Объект <code>EventIngest</code>====
Конфигурация события для загрузки.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|eventType
|string
|Тип события.
Элемент может содержать эти значения
*<code>AVAILABILITY_EVENT</code>
*<code>CUSTOM_ALERT</code>
*<code>CUSTOM_ANNOTATION</code>
*<code>CUSTOM_CONFIGURATION</code>
*<code>CUSTOM_DEPLOYMENT</code>
*<code>CUSTOM_INFO</code>
*<code>ERROR_EVENT</code>
*<code>MARKED_FOR_TERMINATION</code>
*<code>PERFORMANCE_EVENT</code>
*<code>RESOURCE_CONTENTION_EVENT</code>
|-
|title
|string
|Название события.
|-
|startTime
|integer
|Время начала события в миллисекундах UTC.
Если не установлено, используется текущая метка времени.

Может быть <code>null</code>.
|-
|endTime
|integer
|Время окончания события в миллисекундах UTC.
Если не задано, используется время начала плюс время ожидания.

Может быть <code>null</code>.
|-
|timeout
|integer
|Время ожидания события в минутах.
Если не установлено, используется 15.

Может быть <code>null</code>.
|-
|entitySelector
|string
|Селектор сущностей , определяющий набор сущностей Ключ-АСТРОМ, которые будут связаны с событием.
Можно выбрать только объекты, которые были активны в течение последних 24 часов.

Если не установлено, событие связано с <code>dt.entity.environment</code>сущностью среды ( ).

Может быть <code>null</code>.
|-
|properties
|object
|Карта свойств события.
Ключи с префиксом <code>dt.*</code>зарезервированы и могут использоваться для установки свойств события с предопределенной семантикой в продукте Ключ-АСТРОМ. Все остальные ключи интерпретируются как определяемые пользователем свойства события.

Значения зарезервированных Ключ-АСТРОМ свойств (обозначаемых ключом с префиксом <code>dt.*</code>) должны соответствовать требованиям соответствующего свойства.

Может быть <code>null</code>.
|}
===JSON-модель тела запроса===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"eventType": "AVAILABILITY_EVENT",
"title": "string",
"startTime": 1,
"endTime": 1,
"timeout": 1,
"entitySelector": "string",
"properties": {}
}</code>
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|EventIngestResults
|Запрос приема события был получен сервером. Тело ответа указывает для каждого события, было ли его создание успешным.
|}
===Объекты тела ответа===
====Объект <code>EventIngestResults</code>====
Результаты приема событий.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|reportCount
|integer
|Количество созданных отчетов о событиях.
Может быть <code>null</code>.
|-
|eventIngestResults
|EventIngestResult[]
|Результат каждого созданного отчета о событиях.
Может быть <code>null</code>.
|}
====Объект <code>EventIngestResult</code>====
Результат созданного отчета о событиях.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|status
|string
|Статус приема.
Элемент может содержать эти значения
*<code>INVALID_ENTITY_TYPE</code>
*<code>INVALID_METADATA</code>
*<code>INVALID_TIMESTAMPS</code>
*<code>OK</code>
Может быть <code>null</code>.
|-
|correlationId
|string
|Идентификатор корреляции созданного события.
Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"status": "INVALID_ENTITY_TYPE",
"correlationId": "string"
}
]
}</code>
==Примеры==
===Пример 1===
Вариант использования

В этом примере запрос отправляет событие « Помечено для завершения » на узлы, которые планируется удалить. Такие хосты идентифицируются группой хостов cloud-burst-hosts . Событие автоматически применяется ко всем хостам, входящим в группу. В качестве дополнительной информации указываются цель прекращения и номер задания автоматизации.

Маркер API передается в заголовке авторизации .
====Curl====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "MARKED_FOR_TERMINATION",
"title": "Planned host downscale",
"entitySelector": "type(HOST),fromRelationship.isInstanceOf(type(HOST_GROUP),entityName(cloud-burst-hosts))",
"properties": {
"job.number": "21234346"
}
}'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
====Тело запроса====
<code>{
"eventType": "MARKED_FOR_TERMINATION",
"title": "Planned host downscale",
"entitySelector": "type(HOST),fromRelationship.isInstanceOf(type(HOST_GROUP),entityName(cloud-burst-hosts))",
"properties": {
"job.number": "21234346"
}
}</code>
====Тело ответа====
<code>{
"reportCount": 2,
"eventIngestResults": [
{
"correlationId": "41f5d263011a6c9a",
"status": "OK"
},
{
"correlationId": "80eae4d163cc5760",
"status": "OK"
}
]
}</code>
====Код ответа====
201
===Пример 2===
В этом примере запрос отправляет событие Custom info в службу BookingService , помечая ее как цель нагрузочного теста.

Маркер API передается в заголовке авторизации .
====Curl====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "CUSTOM_INFO",
"title": "Loadtest start",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"Tool": "MyLoadTool",
"Load per minute": "100",
"Load pattern": "production"
}
}'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
====Тело запроса====
<code>{
"eventType": "CUSTOM_INFO",
"title": "Loadtest start",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"Tool": "MyLoadTool",
"Load per minute": "100",
"Load pattern": "production"
}
}</code>
====Тело ответа====
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"correlationId": "eba82f647696e485",
"status": "OK"
}
]
}</code>
====Код ответа====
201
===Пример 3===
В этом примере запрос отправляет в службу BookingService событие Error , указывающее на неудачное обновление. Для свойства allowDavisMerge установлено значение , что запрещает ИИ объединять это событие с любым другим событием.<code>false</code>

Маркер API передается в заголовке авторизации .
====Curl====
<code>curl --request POST \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--data '{
"eventType": "ERROR_EVENT",
"title": "Product catalog update failed",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"allowDavisMerge": "false",
"Catalog": "APAC travels",
"Batch processor": "travel-catalog"
}
}'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/ingest</nowiki></code>
====Тело запроса====
<code>{
"eventType": "ERROR_EVENT",
"title": "Product catalog update failed",
"timeout": 30,
"entitySelector": "type(SERVICE),entityName.equals(BookingService)",
"properties": {
"allowDavisMerge": "false",
"Catalog": "APAC travels",
"Batch processor": "travel-catalog"
}
}</code>
====Тело ответа====
<code>{
"reportCount": 1,
"eventIngestResults": [
{
"correlationId": "cefb7ae03ac720b6",
"status": "OK"
}
]
}</code>
====Код ответа====
201

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

IKuznetsov в 14:18, 24 декабря 2024

IKuznetsov в 12:40, 24 декабря 2024

ENetrebin в 16:25, 17 июня 2024

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

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