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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает <code>application/json</code>поле...»)
 
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
Список всех свойств событий, предоставляемых Dynatrace.
Список всех свойств событий, предоставляемых Ключ-АСТРОМ.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Первых компаний, внедривших
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| 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>
|-
|Окружающая среда 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: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|ключ следующей страницы
|nextPageKey
|нить
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.


Строка 39: Строка 32:
|необязательный
|необязательный
|-
|-
|размер страницы
|pageSize
|целое число
|integer
|Количество свойств события в полезной нагрузке одного ответа.
|Количество свойств события в полезной нагрузке одного ответа.


Строка 59: Строка 52:
|-
|-
|200
|200
|Сведения о свойствах события
|EventPropertyDetail
|Успех
|Успех
|}
|}
Строка 65: Строка 58:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>EventPropertyDetails</code> ====
==== Объект <code>EventPropertyDetails</code> ====
Список свойств события.
Список свойств события.
{| class="wikitable"
{| class="wikitable"
Строка 72: Строка 65:
!Описание
!Описание
|-
|-
|свойства события
|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: Строка 85:
Может быть <code>null</code>.
Может быть <code>null</code>.
|-
|-
|общее количество
|totalCount
|целое число
|integer
|Общее количество записей в результате.
|Общее количество записей в результате.
|}
|}
Строка 104: Строка 97:
!Описание
!Описание
|-
|-
|отображаемое имя
|displayName
|нить
|string
|Отображаемое имя свойства события.
|Отображаемое имя свойства события.


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


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


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


Строка 149: Строка 142:
Маркер 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> \
Строка 164: Строка 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
     },
     },

Текущая версия на 16:28, 6 июля 2023

Список всех свойств событий, предоставляемых Ключ-АСТРОМ.

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties

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

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

Параметры

Параметр Тип Описание In Необходимость
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

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

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

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

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

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

запрос необязательный

Ответ

Коды ответов

Код Тип Описание
200 EventPropertyDetail Успех

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

Объект EventPropertyDetails

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

Элемент Тип Описание
eventProperties EventPropertyDetail[] Список свойств события.

Может быть null.

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

Может быть null.

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

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

Может быть null.

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

Объект _ EventPropertyDetail

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

Элемент Тип Описание
displayName string Отображаемое имя свойства события.

Может быть null.

writable boolean Указывает, может ли свойство быть установлено во время приема события.

Может быть null.

key string Ключ свойства события.

Может быть null.

description string Краткое описание свойства события.

Может быть null.

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

{
  "eventProperties": [
    {
      "displayName": "Custom description",
      "writable": true,
      "key": "dt.event.description",
      "description": "string"
    }
  ],
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "totalCount": 1
}

Пример

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

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

Curl

curl --request GET \
  --url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties?pageSize=3' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties?pageSize=3

Тело ответа

{
  "totalCount": 23,
  "pageSize": 3,
  "nextPageKey": "AQAAAAMBAAAAAw==",
  "eventProperties": [
    {
      "key": "dt.event.allow_ai_merge",
      "displayName": "Allow AI merge",
      "description": "Allow 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
    }
  ]
}

Код ответа

200