ENetrebin (обсуждение | вклад) (Новая страница: «Получает базовые данные указанной службы. Запрос создает <code>application/json</code>полезную нагр...») |
Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[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=%D0%95%D0%B4%D0%B8%D0%BD%D1%8B%D0%B9%D0%90%D0%B3%D0%B5%D0%BD%D1%82%20%D0%BD%D0%B0%20%D1%85%D0%BE%D1%81%D1%82%D0%B5-,%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F,-%D0%9F%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Топология] / [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=POST%20%D1%82%D1%8D%D0%B3%D0%BE%D0%B2-,%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B Сервисы] / GET базового уровня*''''' | |||
Получает базовые данные указанной службы. | Получает базовые данные указанной службы. | ||
| Строка 4: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |GET | | rowspan="2" |GET | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}/baseline</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}/baseline</nowiki></code> | ||
|- | |- | ||
| Строка 24: | Строка 26: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима требуемой службы. | ||
|path | |path | ||
|требуется | |требуется | ||
| Строка 65: | Строка 67: | ||
==== Объект <code>EntityBaselineData</code> ==== | ==== Объект <code>EntityBaselineData</code> ==== | ||
Базовые данные для объекта | Базовые данные для объекта АппОптима для определенной метрики продолжительности. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 73: | Строка 75: | ||
|entityId | |entityId | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима. | ||
|- | |- | ||
|displayName | |displayName | ||
| Строка 101: | Строка 103: | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"entityId": "string", | "entityId": "string", | ||
"displayName": "string", | "displayName": "string", | ||
| Строка 117: | Строка 119: | ||
} | } | ||
] | ] | ||
} | } | ||
Текущая версия от 12:48, 29 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / Топология / Сервисы / GET базового уровня*
Получает базовые данные указанной службы.
Запрос создает application/jsonполезную нагрузку.
| GET | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}/baseline
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}/baseline
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | Шт | Необходимость |
|---|---|---|---|---|
| meIdentifier | string | Идентификатор объекта АппОптима требуемой службы. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ServiceBaselineValues | Успех |
Объекты тела ответа
Объект ServiceBaselineValues
Базовые данные для службы и ее дочерних элементов для метрики продолжительности времени ответа .
| Элемент | Тип | Описание |
|---|---|---|
| entityId | string | Идентификатор службы. |
| displayName | string | Отображаемое имя службы. |
| serviceResponseTimeBaselines | EntityBaselineData[] | Базовые данные для метрики продолжительности времени ответа . |
Объект EntityBaselineData
Базовые данные для объекта АппОптима для определенной метрики продолжительности.
| Элемент | Тип | Описание |
|---|---|---|
| entityId | string | Идентификатор объекта АппОптима. |
| displayName | string | Отображаемое имя объекта. |
| errorRate | number | Базовый уровень частоты ошибок. |
| hasLoadBaseline | boolean | Объект имеет базовый план нагрузки ( true) или не имеет ( false).
|
| microsMedian | number | Средняя базовая линия в микросекундах. |
| micros90thPercentile | number | Базовый уровень 90-го процентиля в микросекундах. |
| childBaselines | EntityBaselineData[] | Базовые данные для дочерних объектов этого объекта, например SERVICE_METHODфайл SERVICE_METHOD_GROUP.
|
JSON-модель тела ответа
<{
"entityId": "string",
"displayName": "string",
"serviceResponseTimeBaselines": [
{
"entityId": "string",
"displayName": "string",
"errorRate": 1,
"hasLoadBaseline": true,
"microsMedian": 1,
"micros90thPercentile": 1,
"childBaselines": [
{}
]
}
]
}