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

IKuznetsov в 21:09, 25 декабря 2024

2024-12-25T21:09:02Z

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

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
	\|-		\|-
Строка 123:		Строка 123:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"eventProperties": [		"eventProperties": [
	{		{
Строка 143:		Строка 143:

	==== Curl ====		==== Curl ====
	<~~code>~~curl --request GET \		<curl --request GET \
	--url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties?pageSize=3'</nowiki> \		--url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties?pageSize=3'</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 151:		Строка 151:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"totalCount": 23,		"totalCount": 23,
	"pageSize": 3,		"pageSize": 3,

ENetrebin в 16:28, 6 июля 2023

2023-07-06T16:28:36Z

← Предыдущая версия		Версия от 16:28, 6 июля 2023
Строка 3:		Строка 3:
	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|~~ПОЛУЧИТЬ~~		\| rowspan="2" \|GET
	\|~~Удалось~~		\|Managed
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
	\|-		\|-
	\|~~SaaS~~		\|Среда АктивногоШлюза
	~~\|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties</nowiki></code>~~
	\|-
	~~\|Окружающая среда~~ АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
	\|}		\|}
Строка 61:		Строка 58:
	=== Объекты тела ответа ===		=== Объекты тела ответа ===

	==== Объект _ <code>EventPropertyDetails</code> ====		==== Объект <code>EventPropertyDetails</code> ====
	Список свойств события.		Список свойств события.
	{\| class="wikitable"		{\| class="wikitable"
Строка 160:		Строка 157:
	"eventProperties": [		"eventProperties": [
	{		{
	"key": "dt.event.~~allow_davis_merge~~",		"key": "dt.event.allow_ai_merge",
	"displayName": "Allow ~~Davis~~ merge",		"displayName": "Allow AI merge",
	"description": "Allow ~~Davis~~ AI to merge this event into existing problems (true) or force creating a new problem (false)",		"description": "Allow AI to merge this event into existing problems (true) or force creating a new problem (false)",
	"writable": true		"writable": true
	},		},

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

2022-04-14T14:17:35Z

Параметры

← Предыдущая версия		Версия от 14:17, 14 апреля 2022
Строка 25:		Строка 25:
	!Необходимость		!Необходимость
	\|-		\|-
	\|~~ключ следующей страницы~~		\|nextPageKey
	\|string		\|string
	\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.		\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Строка 35:		Строка 35:
	\|необязательный		\|необязательный
	\|-		\|-
	\|~~размер страницы~~		\|pageSize
	\|integer		\|integer
	\|Количество свойств события в полезной нагрузке одного ответа.		\|Количество свойств события в полезной нагрузке одного ответа.
Строка 55:		Строка 55:
	\|-		\|-
	\|200		\|200
	\|~~EventPropertyDetails~~		\|EventPropertyDetail
	\|Успех		\|Успех
	\|}		\|}
Строка 107:		Строка 107:
	\|-		\|-
	\|writable		\|writable
	\|~~логический~~		\|boolean
	\|Указывает, может ли свойство быть установлено во время приема события.		\|Указывает, может ли свойство быть установлено во время приема события.

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

2022-04-14T14:13:28Z

← Предыдущая версия		Версия от 14:13, 14 апреля 2022
Строка 1:		Строка 1:
	Список всех свойств событий, предоставляемых ~~Dynatrace~~.		Список всех свойств событий, предоставляемых Ключ-АСТРОМ.

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

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

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

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

	== Параметры ==		== Параметры ==
Строка 26:		Строка 22:
	!Тип		!Тип
	!Описание		!Описание
	!В		!In
	!~~Необходимый~~		!Необходимость
	\|-		\|-
	\|ключ следующей страницы		\|ключ следующей страницы
	\|~~нить~~		\|string
	\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.		\|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Строка 40:		Строка 36:
	\|-		\|-
	\|размер страницы		\|размер страницы
	\|~~целое число~~		\|integer
	\|Количество свойств события в полезной нагрузке одного ответа.		\|Количество свойств события в полезной нагрузке одного ответа.

Строка 59:		Строка 55:
	\|-		\|-
	\|200		\|200
	\|~~Сведения о свойствах события~~		\|EventPropertyDetails
	\|Успех		\|Успех
	\|}		\|}
Строка 72:		Строка 68:
	!Описание		!Описание
	\|-		\|-
	\|~~свойства события~~		\|eventProperties
	\|~~Сведения о свойстве события~~ []		\|EventPropertyDetail[]
	\|Список свойств события.		\|Список свойств события.

	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~размер страницы~~		\|pageSize
	\|~~целое число~~		\|integer
	\|Количество записей на странице.		\|Количество записей на странице.

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

Строка 92:		Строка 88:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~общее количество~~		\|totalCount
	\|~~целое число~~		\|integer
	\|Общее количество записей в результате.		\|Общее количество записей в результате.
	\|}		\|}
Строка 104:		Строка 100:
	!Описание		!Описание
	\|-		\|-
	\|~~отображаемое имя~~		\|displayName
	\|~~нить~~		\|string
	\|Отображаемое имя свойства события.		\|Отображаемое имя свойства события.

	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~доступный для записи~~		\|writable
	\|логический		\|логический
	\|Указывает, может ли свойство быть установлено во время приема события.		\|Указывает, может ли свойство быть установлено во время приема события.
Строка 116:		Строка 112:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~ключ~~		\|key
	\|~~нить~~		\|string
	\|Ключ свойства события.		\|Ключ свойства события.

	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~описание~~		\|description
	\|~~нить~~		\|string
	\|Краткое описание свойства события.		\|Краткое описание свойства события.

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

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

ENetrebin: Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает `application/json`поле...»

2022-04-14T13:37:04Z

Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает <code>application/json</code>поле...»

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

Список всех свойств событий, предоставляемых Dynatrace.

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

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

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

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

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

Если не установлено, используется 100.
|запрос
|необязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Сведения о свойствах события
|Успех
|}

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

==== Объект _ <code>EventPropertyDetails</code> ====
Список свойств события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|свойства события
|Сведения о свойстве события []
|Список свойств события.

Может быть <code>null</code>.
|-
|размер страницы
|целое число
|Количество записей на странице.

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

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

Может быть <code>null</code>.
|-
|общее количество
|целое число
|Общее количество записей в результате.
|}

==== Объект _ <code>EventPropertyDetail</code> ====
Конфигурация свойства события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|отображаемое имя
|нить
|Отображаемое имя свойства события.

Может быть <code>null</code>.
|-
|доступный для записи
|логический
|Указывает, может ли свойство быть установлено во время приема события.

Может быть <code>null</code>.
|-
|ключ
|нить
|Ключ свойства события.

Может быть <code>null</code>.
|-
|описание
|нить
|Краткое описание свойства события.

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

=== JSON-модель тела ответа ===
<code>{
"eventProperties": [
{
"displayName": "Custom description",
"writable": true,
"key": "dt.event.description",
"description": "string"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}</code>

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

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

==== Завиток ====
<code>curl --request GET \
--url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties?pageSize=3'</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

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

==== Тело ответа ====
<code>{
"totalCount": 23,
"pageSize": 3,
"nextPageKey": "AQAAAAMBAAAAAw==",
"eventProperties": [
{
"key": "dt.event.allow_davis_merge",
"displayName": "Allow Davis merge",
"description": "Allow Davis AI to merge this event into existing problems (true) or force creating a new problem (false)",
"writable": true
},
{
"key": "dt.event.baseline.service_method",
"displayName": "Baseline affected service method",
"description": "Lists affected service methods of the triggered service event",
"writable": false
},
{
"key": "dt.event.baseline.total_load",
"displayName": "Baseline total load",
"description": "The load (calls per minute) of the entire service or application for triggered event",
"writable": false
}
]
}</code>

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

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

IKuznetsov в 21:09, 25 декабря 2024

ENetrebin в 16:28, 6 июля 2023

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

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

ENetrebin: Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает application/jsonполе...»

ENetrebin: Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает `application/json`поле...»