ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 1: | Строка 1: | ||
'''''[[API | '''''[[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 всех типов события''''' | ||
Список всех типов событий, которые могут возникнуть в вашей среде. | Список всех типов событий, которые могут возникнуть в вашей среде. | ||
Строка 10: | Строка 10: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |GET | | rowspan="2" |GET | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code> | ||
|- | |- | ||
Строка 120: | Строка 120: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"eventTypeInfos": [ | "eventTypeInfos": [ | ||
{ | { | ||
Строка 132: | Строка 132: | ||
"nextPageKey": "AQAAABQBAAAABQ==", | "nextPageKey": "AQAAABQBAAAABQ==", | ||
"totalCount": 1 | "totalCount": 1 | ||
} | } | ||
==Пример== | ==Пример== | ||
В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей | В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей | ||
Строка 138: | Строка 138: | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации . | ||
====Curl==== | ====Curl==== | ||
< | <curl --request GET \ | ||
--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \ | --url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' | ||
====URL-адрес запроса==== | ====URL-адрес запроса==== | ||
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code> | <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <{ | ||
"totalCount": 144, | "totalCount": 144, | ||
"pageSize": 3, | "pageSize": 3, | ||
Строка 167: | Строка 167: | ||
} | } | ||
] | ] | ||
} | } | ||
====Код ответа==== | ====Код ответа==== | ||
200 | 200 |
Текущая версия от 14:18, 24 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / События v2 / GET всех типов события
Список всех типов событий, которые могут возникнуть в вашей среде.
Запрос создает application/json
полезную нагрузку.
Первых компаний, внедривших
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
GET | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes
|
Аутентификация
Чтобы выполstring этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | необязательный |
pageSize | integer | Количество типов событий в полезной нагрузке одного ответа.
Максимально допустимый размер страницы – 500. Если не установлено, используется 100. |
запрос | необязательный |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | EventTypeList | Успех |
Объекты тела ответа
Объект EventTypeList
Список типов событий.
Элемент | Тип | Описание |
---|---|---|
eventTypeInfos | ventType[] | Список типов событий.
Может быть |
pageSize | integer | Количество записей на странице.
Может быть |
nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение null на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. Может быть |
totalCount | integer | Общее количество записей в результате. |
Объект _ EventType
Конфигурация типа события.
Элемент | Тип | Описание |
---|---|---|
severityLevel | string | Уровень серьезности, связанный с типом события.
Элемент может содержать эти значения
Может быть |
displayName | string | Отображаемое имя типа события.
Может быть |
type | string | Тип события.
Может быть |
description | string | Краткое описание типа события.
Может быть |
JSON-модель тела ответа
<{ "eventTypeInfos": [ { "severityLevel": "PERFORMANCE", "displayName": "High CPU", "type": "OSI_HIGH_CPU", "description": "string" } ], "pageSize": 1, "nextPageKey": "AQAAABQBAAAABQ==", "totalCount": 1 }
Пример
В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей
Маркер API передается в заголовке авторизации .
Curl
<curl --request GET \ --url 'https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3' \ --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3
Тело ответа
<{ "totalCount": 144, "pageSize": 3, "nextPageKey": "AQAAAGQBAAAAZA==", "eventTypeInfos": [ { "type": "APPLICATION_UNEXPECTED_LOW_LOAD", "displayName": "Application low traffic", "severityLevel": "AVAILABILITY", "description": "Unexpected low traffic" }, { "type": "MOBILE_APP_CRASH_RATE_INCREASED", "displayName": "Mobile app crash rate increase", "severityLevel": "ERROR" }, { "type": "APPLICATION_SLOWDOWN", "displayName": "Application slowdown", "severityLevel": "PERFORMANCE", "description": "User action duration degradation" } ] }
Код ответа
200