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

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



Версия 14:17, 14 апреля 2022

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

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

ПОЛУЧИТЬ Удалось https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties
SaaS https://{your-environment-id}.live.dynatrace.com/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_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