Получение всех типов событий - История изменений

ENetrebin в 17:04, 20 февраля 2023

2023-02-20T17:04:42Z

← Предыдущая		Версия 17:04, 20 февраля 2023
Строка 7:		Строка 7:
	Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.		Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|GET		\| rowspan="2" \|GET
	\|Managed		\|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>
	\|-		\|-
	\|~~SaaS~~		\|Среда АктивногоШлюза
	~~\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>~~
	\|-
	~~\|Окружающая среда~~ АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-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>
	\|}		\|}
Строка 161:		Строка 158:
	==== Curl ====		==== Curl ====
	<code>curl --request GET \		<code>curl --request GET \
	--url '<nowiki>https://mySampleEnv.live.~~dynatrace~~.~~com~~/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>

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
	<code><nowiki>https://mySampleEnv.live.~~dynatrace~~.~~com~~/api/v2/eventTypes?pageSize=3</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>

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

ENetrebin: /* Параметры */

2022-04-14T13:11:59Z

Параметры

← Предыдущая		Версия 13:11, 14 апреля 2022
Строка 26:		Строка 26:
	!Тип		!Тип
	!Описание		!Описание
	!В		!In
	!Необходимость		!Необходимость
	\|-		\|-

ENetrebin: /* Параметры */

2022-04-14T13:10:45Z

Параметры

← Предыдущая		Версия 13:10, 14 апреля 2022
Строка 27:		Строка 27:
	!Описание		!Описание
	!В		!В
	!~~Необходимый~~		!Необходимость
	\|-		\|-
	\|~~ключ следующей страницы~~		\|nextPageKey
	\|string		\|string
	\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.		\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Строка 39:		Строка 39:
	\|необязательный		\|необязательный
	\|-		\|-
	\|~~размер страницы~~		\|pageSize
	\|integer		\|integer
	\|Количество типов событий в полезной нагрузке одного ответа.		\|Количество типов событий в полезной нагрузке одного ответа.
Строка 59:		Строка 59:
	\|-		\|-
	\|200		\|200
	\|~~Список типов событий~~		\|EventTypeList
	\|Успех		\|Успех
	\|}		\|}
Строка 72:		Строка 72:
	!Описание		!Описание
	\|-		\|-
	\|~~информация о типе события~~		\|eventTypeInfos
	\|~~Тип события~~ []		\|ventType[]
	\|Список типов событий.		\|Список типов событий.

	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~размер страницы~~		\|pageSize
	\|integer		\|integer
	\|Количество записей на странице.		\|Количество записей на странице.
Строка 84:		Строка 84:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~ключ следующей страницы~~		\|nextPageKey
	\|string		\|string
	\|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.		\|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
Строка 92:		Строка 92:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~общее количество~~		\|totalCount
	\|integer		\|integer
	\|Общее количество записей в результате.		\|Общее количество записей в результате.
Строка 104:		Строка 104:
	!Описание		!Описание
	\|-		\|-
	\|~~Уровень опасности~~		\|severityLevel
	\|string		\|string
	\|Уровень серьезности, связанный с типом события.		\|Уровень серьезности, связанный с типом события.
Строка 120:		Строка 120:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~отображаемое имя~~		\|displayName
	\|string		\|string
	\|Отображаемое имя типа события.		\|Отображаемое имя типа события.
Строка 126:		Строка 126:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~тип~~		\|type
	\|string		\|string
	\|Тип события.		\|Тип события.
Строка 132:		Строка 132:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~описание~~		\|description
	\|string		\|string
	\|Краткое описание типа события.		\|Краткое описание типа события.
Строка 159:		Строка 159:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .

	==== ~~Завиток~~ ====		==== Curl ====
	<code>curl --request GET \		<code>curl --request GET \
	--url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3'</nowiki> \		--url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3'</nowiki> \

ENetrebin в 12:09, 14 апреля 2022

2022-04-14T12:09:28Z

← Предыдущая		Версия 12:09, 14 апреля 2022
Строка 7:		Строка 7:
	Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.		Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|~~ПОЛУЧИТЬ~~		\| rowspan="3" \|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>
	\|-		\|-
Строка 14:		Строка 14:
	\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>		\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>
	\|-		\|-
	\|Окружающая среда ~~ActiveGate~~		\|Окружающая среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-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>
	\|}		\|}

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

	== Параметры ==		== Параметры ==
Строка 30:		Строка 30:
	\|-		\|-
	\|ключ следующей страницы		\|ключ следующей страницы
	\|~~нить~~		\|string
	\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.		\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

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

Строка 105:		Строка 105:
	\|-		\|-
	\|Уровень опасности		\|Уровень опасности
	\|~~нить~~		\|string
	\|Уровень серьезности, связанный с типом события.		\|Уровень серьезности, связанный с типом события.

Строка 121:		Строка 121:
	\|-		\|-
	\|отображаемое имя		\|отображаемое имя
	\|~~нить~~		\|string
	\|Отображаемое имя типа события.		\|Отображаемое имя типа события.

Строка 127:		Строка 127:
	\|-		\|-
	\|тип		\|тип
	\|~~нить~~		\|string
	\|Тип события.		\|Тип события.

Строка 133:		Строка 133:
	\|-		\|-
	\|описание		\|описание
	\|~~нить~~		\|string
	\|Краткое описание типа события.		\|Краткое описание типа события.

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


2022-04-14T12:06:07Z
Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде.  Запрос создает <code>appli...»
Новая страница
Список всех типов событий, которые могут возникнуть в вашей среде.



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



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



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

{| class="wikitable"

| rowspan="3" |ПОЛУЧИТЬ

|Удалось

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

|-

|SaaS

|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>

|-

|Окружающая среда ActiveGate

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

|}



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

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



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

{| class="wikitable"

!Параметр

!Тип

!Описание

!В

!Необходимый

|-

|ключ следующей страницы

|нить

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



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



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

|запрос

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

|-

|размер страницы

|integer

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



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



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

|запрос

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

|}



== Ответ ==



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

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

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

|Успех

|}



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



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

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

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|информация о типе события

|Тип события []

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



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

|-

|размер страницы

|integer

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



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

|-

|ключ следующей страницы

|нить

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



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



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

|-

|общее количество

|integer

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

|}



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

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

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|Уровень опасности

|нить

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



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



* <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>.

|-

|отображаемое имя

|нить

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



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

|-

|тип

|нить

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



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

|-

|описание

|нить

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



Может быть <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 передается в заголовке авторизации .



==== Завиток ====

 <code>curl --request GET \

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

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



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

 <code><nowiki>https://mySampleEnv.live.dynatrace.com/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

Получение всех типов событий - История изменений

ENetrebin в 17:04, 20 февраля 2023

ENetrebin: /* Параметры */

ENetrebin: /* Параметры */

ENetrebin в 12:09, 14 апреля 2022

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

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