GET всех типов событий - История изменений

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

2024-12-24T14:18:20Z

← Предыдущая версия		Версия от 14:18, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [~~[API АппОптима~~#:~:text=DELETE ~~тегов~~-,~~Развёртывание~~,-~~править\|~~Развёртывание]] / [~~[API АппОптима~~#:~:text=~~развертывания из Jenkins~~-,~~События v2~~,-GET ~~списка событий\|~~События v2]] / GET всех типов события'''''		'''''[[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] / GET всех типов события'''''

	Список всех типов событий, которые могут возникнуть в вашей среде.		Список всех типов событий, которые могут возникнуть в вашей среде.
Строка 132:		Строка 132:
	"nextPageKey": "AQAAABQBAAAABQ==",		"nextPageKey": "AQAAABQBAAAABQ==",
	"totalCount": 1		"totalCount": 1
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей		В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей
Строка 140:		Строка 140:
	<curl --request GET \		<curl --request GET \
	--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \		--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>
Строка 167:		Строка 167:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	200		200

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

2024-12-24T12:42:31Z

← Предыдущая версия		Версия от 12:42, 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 / GET всех типов события'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править\|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий\|События v2]] / GET всех типов события'''''

	Список всех типов событий, которые могут возникнуть в вашей среде.		Список всех типов событий, которые могут возникнуть в вашей среде.
Строка 10:		Строка 10:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
	\|-		\|-
Строка 120:		Строка 120:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"eventTypeInfos": [		"eventTypeInfos": [
	{		{
Строка 138:		Строка 138:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl --request GET \		<curl --request GET \
	--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \		--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 144:		Строка 144:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"totalCount": 144,		"totalCount": 144,
	"pageSize": 3,		"pageSize": 3,

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

2024-06-17T16:26:17Z

← Предыдущая версия		Версия от 16:26, 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 / GET всех типов события'''''

	Список всех типов событий, которые могут возникнуть в вашей среде.		Список всех типов событий, которые могут возникнуть в вашей среде.

ENetrebin: Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде. Запрос создает `appli...»`


2024-06-13T17:53:03Z
Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде.  Запрос создает <code>appli...»
Новая страница
Список всех типов событий, которые могут возникнуть в вашей среде.



Запрос создает <code>application/json</code>полезную нагрузку.



Первых компаний, внедривших



Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.

{| class="wikitable"

| rowspan="2" |GET

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>

|-

|Среда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>

|}

==Аутентификация==

Чтобы выполstring этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

==Параметры==

{| class="wikitable"

!Параметр

!Тип

!Описание

!In

!Необходимость

|-

|nextPageKey

|string

|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .



Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

|запрос

|необязательный

|-

|pageSize

|integer

|Количество типов событий в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.



Если не установлено, используется 100.

|запрос

|необязательный

|}

==Ответ==

===Коды ответов===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

|EventTypeList

|Успех

|}

===Объекты тела ответа===

====Объект <code>EventTypeList</code>====

Список типов событий.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|eventTypeInfos

|ventType[]

|Список типов событий.

Может быть <code>null</code>.

|-

|pageSize

|integer

|Количество записей на странице.

Может быть <code>null</code>.

|-

|nextPageKey

|string

|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.



Может быть <code>null</code>.

|-

|totalCount

|integer

|Общее количество записей в результате.

|}

====Объект _ <code>EventType</code>====

Конфигурация типа события.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|severityLevel

|string

|Уровень серьезности, связанный с типом события.

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

*<code>AVAILABILITY</code>

*<code>CUSTOM_ALERT</code>

*<code>ERROR</code>

*<code>INFO</code>

*<code>MONITORING_UNAVAILABLE</code>

*<code>PERFORMANCE</code>

*<code>RESOURCE_CONTENTION</code>

Может быть <code>null</code>.

|-

|displayName

|string

|Отображаемое имя типа события.

Может быть <code>null</code>.

|-

|type

|string

|Тип события.

Может быть <code>null</code>.

|-

|description

|string

|Краткое описание типа события.

Может быть <code>null</code>.

|}

===JSON-модель тела ответа===

 <code>{

   "eventTypeInfos": [

     {

       "severityLevel": "PERFORMANCE",

       "displayName": "High CPU",

       "type": "OSI_HIGH_CPU",

       "description": "string"

     }

   ],

   "pageSize": 1,

   "nextPageKey": "AQAAABQBAAAABQ==",

   "totalCount": 1

 }</code>

==Пример==

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



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

====Curl====

 <code>curl --request GET \

   --url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \

   --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

====URL-адрес запроса====

 <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>

====Тело ответа====

 <code>{

   "totalCount": 144,

   "pageSize": 3,

   "nextPageKey": "AQAAAGQBAAAAZA==",

   "eventTypeInfos": [

     {

       "type": "APPLICATION_UNEXPECTED_LOW_LOAD",

       "displayName": "Application low traffic",

       "severityLevel": "AVAILABILITY",

       "description": "Unexpected low traffic"

     },

       {

       "type": "MOBILE_APP_CRASH_RATE_INCREASED",

       "displayName": "Mobile app crash rate increase",

       "severityLevel": "ERROR"

     },

     {

       "type": "APPLICATION_SLOWDOWN",

       "displayName": "Application slowdown",

       "severityLevel": "PERFORMANCE",

       "description": "User action duration degradation"

     }

   ]

 }</code>

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

200

GET всех типов событий - История изменений

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

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

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

ENetrebin: Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде. Запрос создает appli...»

ENetrebin: Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде. Запрос создает `appli...»`