Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

GET базового уровня: различия между версиями

Материал из Документация АппОптима
(Новая страница: «Получает базовые данные указанного приложения. Запрос создает <code>application/json</code>полезную...»)
 
Нет описания правки
 
(не показаны 2 промежуточные версии 2 участников)
Строка 4: Строка 4:
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |GET
| rowspan="2" |GET
|Удалось
|АппОптима
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}/baseline</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}/baseline</nowiki></code>
|-
|-
Строка 24: Строка 24:
|meIdentifier
|meIdentifier
|string
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого приложения.
|Идентификатор объекта АппОптима требуемого приложения.
|path
|path
|требуется
|требуется
Строка 65: Строка 65:
|entityId
|entityId
|string
|string
|Идентификатор объекта Ключ-АСТРОМ для приложения.
|Идентификатор объекта АппОптима для приложения.
|-
|-
|displayName
|displayName
Строка 105: Строка 105:


==== Объект <code>EntityBaselineData</code> ====
==== Объект <code>EntityBaselineData</code> ====
Базовые данные для объекта Ключ-АСТРОМ для определенной метрики продолжительности.
Базовые данные для объекта АппОптима для определенной метрики продолжительности.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 113: Строка 113:
|entityId
|entityId
|string
|string
|Идентификатор объекта Ключ-АСТРОМ.
|Идентификатор объекта АппОптима.
|-
|-
|displayName
|displayName
Строка 141: Строка 141:


=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <{
   "entityId": "string",
   "entityId": "string",
   "displayName": "string",
   "displayName": "string",
Строка 178: Строка 178:
     {}
     {}
   ]
   ]
  }</code>
  }

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

Получает базовые данные указанного приложения.

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

GET АппОптима https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}/baseline
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}/baseline

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

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

Параметры

Параметр Тип Описание In Необходимость
meIdentifier string Идентификатор объекта АппОптима требуемого приложения. path требуется

Ответ

Коды ответов

Код Тип Описание
200 Базовые значения приложения Успех

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

Объект ApplicationBaselineValues

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

Метрика продолжительности является одной из следующих:

  • DOM interactive
  • HTML downloaded
  • Load event end
  • Load event start
  • Response time
  • Speed index
  • Time to first byte
  • Visually complete
Элемент Тип Описание
entityId string Идентификатор объекта АппОптима для приложения.
displayName string Имя приложения, отображаемое в пользовательском интерфейсе.
applicationDomInteractiveBaselines EntityBaselineData[] Базовые данные для метрики интерактивной продолжительности DOM.
applicationHtmlDownloadedBaselines EntityBaselineData[] Базовые данные для метрики продолжительности загрузки HTML .
applicationLoadEventEndBaselines EntityBaselineData[] Базовые данные для метрики продолжительности окончания события загрузки .
applicationLoadEventStartBaselines EntityBaselineData[] Базовые данные для метрики длительности начала события загрузки .
applicationResponseTimeBaselines EntityBaselineData[] Базовые данные для метрики продолжительности времени ответа .
applicationSpeedIndexBaselines EntityBaselineData[] Базовые данные для метрики продолжительности индекса скорости .
applicationTimeToFirstByteBaselines EntityBaselineData[] Базовые данные для метрики времени до первого байта .
applicationVisualCompleteBaselines 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",
  "applicationDomInteractiveBaselines": [
    {
      "entityId": "string",
      "displayName": "string",
      "errorRate": 1,
      "hasLoadBaseline": true,
      "microsMedian": 1,
      "micros90thPercentile": 1,
      "childBaselines": [
        {}
      ]
    }
  ],
  "applicationHtmlDownloadedBaselines": [
    {}
  ],
  "applicationLoadEventEndBaselines": [
    {}
  ],
  "applicationLoadEventStartBaselines": [
    {}
  ],
  "applicationResponseTimeBaselines": [
    {}
  ],
  "applicationSpeedIndexBaselines": [
    {}
  ],
  "applicationTimeToFirstByteBaselines": [
    {}
  ],
  "applicationVisualCompleteBaselines": [
    {}
  ]
}