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

Текущая версия от 14:17, 24 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / События v2 / GET всех свойств события

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

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties`
GET	Среда АктивногоШлюза	`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.ruscomtech.com/api/v2/eventProperties?pageSize=3' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.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

@@ Строка 1: / Строка 1: @@
-'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий|События v2]] / GET всех свойств события'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%80%D0%B0%D0%B7%D0%B2%D0%B5%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B8%D0%B7%20Jenkins-,%D0%A1%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F%20v2,-GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9 События v2] / GET всех свойств события'''''
 Список всех свойств событий, предоставляемых АппОптима.
@@ Строка 120: / Строка 120: @@
     "nextPageKey": "AQAAABQBAAAABQ==",
     "totalCount": 1
-  }</code>
+  }
 ==Пример==
 В этом примере в запросе перечислены все доступные свойства событий, доступные в среде mySampleEnv . Результат усекается до трех записей
@@ Строка 128: / Строка 128: @@
   <curl --request GET \
     --url '<nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3'</nowiki> \
-    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ====URL-адрес запроса====
   <code><nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3</nowiki></code>
@@ Строка 156: / Строка 156: @@
       }
     ]
-  }</code>
+  }
 ====Код ответа====