Получение свойства события: различия между версиями

Текущая версия от 20:49, 25 декабря 2024

Получает сведения о свойстве события.

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}`
	Окружающая среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}`

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

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

Параметры

Параметр	Тип	Описание	В	Необходимый
свойствоКлюч	string	Ключ свойства события, который вы запрашиваете.	дорожка	обязательный

Ответ

Коды ответов

Код	Тип	Описание
200	Сведения о свойстве события	Успех

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

Объект _ `EventPropertyDetail`

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

Элемент	Тип	Описание
отображаемое имя	string	Отображаемое имя свойства события. Может быть `null`.
доступный для записи	boolean	Указывает, может ли свойство быть установлено во время приема события. Может быть `null`.
ключ	string	Ключ свойства события. Может быть `null`.
описание	string	Краткое описание свойства события. Может быть `null`.

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

<{
  "displayName": "Custom description",
  "writable": true,
  "key": "dt.event.description",
  "description": "string"
}

Пример

В этом примере запрос запрашивает сведения о свойстве пользовательского источника события.

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

Curl

<curl --request GET \
  --url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source

Тело ответа

<{
  "key": "dt.event.source",
  "displayName": "Custom source",
  "description": "The name or ID of the external source of the event",
  "writable": true
}

Код ответа

200

@@ Строка 3: / Строка 3: @@
 Запрос создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="3" |GET
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code>
 |-
@@ Строка 10: / Строка 10: @@
 |<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}</nowiki></code>
 |-
-|Окружающая среда ActiveGate
+|Окружающая среда АктивногоШлюза
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code>
 |}
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 26: / Строка 26: @@
 |-
 |свойствоКлюч
-|нить
+|string
 |Ключ свойства события, который вы запрашиваете.
 |дорожка
@@ Строка 55: / Строка 55: @@
 |-
 |отображаемое имя
-|нить
+|string
 |Отображаемое имя свойства события.
@@ Строка 61: / Строка 61: @@
 |-
 |доступный для записи
-|логический
+|boolean
 |Указывает, может ли свойство быть установлено во время приема события.
@@ Строка 67: / Строка 67: @@
 |-
 |ключ
-|нить
+|string
 |Ключ свойства события.
@@ Строка 73: / Строка 73: @@
 |-
 |описание
-|нить
+|string
 |Краткое описание свойства события.
@@ Строка 80: / Строка 80: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "displayName": "Custom description",
     "writable": true,
@@ Строка 93: / Строка 93: @@
 ==== Curl ====
-  <code>curl --request GET \
+  <curl --request GET \
     --url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source'</nowiki> \
     --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
@@ Строка 101: / Строка 101: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "key": "dt.event.source",
     "displayName": "Custom source",