Получение всех свойств события

Материал из Dynatrace
Версия от 13:37, 14 апреля 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех свойств событий, предоставляемых Dynatrace. Запрос создает <code>application/json</code>поле...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

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

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

ПОЛУЧИТЬ Удалось https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties
Окружающая среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties

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

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

Параметры

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

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

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

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

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

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

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

Ответ

Коды ответов

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

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

Объект _ EventPropertyDetails

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

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

Может быть null.

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

Может быть null.

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

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

Может быть null.

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

Объект _ EventPropertyDetail

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

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

Может быть null.

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

Может быть null.

ключ нить Ключ свойства события.

Может быть null.

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

Может быть null.

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

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

Пример

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

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

Завиток

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_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
    }
  ]
}

Код ответа

200