GET один SLO

Материал из Документация Ключ-АСТРОМ
Версия от 14:46, 19 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает параметр указанной цели уровня обслуживания (SLO). Если указаны параметры from и to...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает параметр указанной цели уровня обслуживания (SLO).

Если указаны параметры from и to , SLO рассчитывается для этого таймфрейма; в противном случае используется собственный таймфрейм SLO.

Запрос создает в качестве полезной нагрузки application/json формат.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/slo/{id}
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/slo/{id}

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

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

Параметры

Параметр Тип Описание In Необходимость
from string Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минуты
    • h: часы
    • d: дни
    • w: недели
    • M: месяцы
    • y: годы

Если не задано, используется относительный двухнедельный таймфрейм ( now-2w).

query по желанию
to string Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минуты
    • h: часы
    • d: дни
    • w: недели
    • M: месяцы
    • y: годы

Если не установлено, используется текущая метка времени.

query по желанию
id string Идентификатор требуемого SLO. path требуется
timeFrame string Таймфрейм для расчета значений SLO:
  • CURRENT: собственный таймфрейм SLO.
  • GTF: период времени, заданный параметрами from и to .

Если не задано, используется CURRENTзначение.

Элемент может содержать эти значения

  • CURRENT
  • GTF
 query по желанию

Ответ

Коды ответов

Код Тип Описание
200 SLO Успех. Ответ содержит параметры и расчетные значения запрошенного SLO.
400 ErrorEnvelope Не удалось. Ввод недействителен.
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект SLO

Параметры целевого уровня обслуживания (SLO).

Элемент Тип Описание
problemFilters string[] УСТАРЕЛО

Фильтр сущностей для получения количества проблем, связанных с SLO. Генерируется автоматически, если в SLO не был добавлен фильтр.

metricExpression string Процентное выражение метрики для расчета SLO.
useRateMetric boolean УСТАРЕЛО

Тип метрики для расчета SLO:

  • true: существующая процентная метрика.
  • false: соотношение двух показателей.

Список доступных метрик см. на странице встроенных метрик или попробуйте вызов API GET метрик .

metricRate string УСТАРЕЛО

Процентная метрика для расчета SLO.

Требуется, если для параметра useRateMetric установлено значение true.

metricNumerator string УСТАРЕЛО

Метрика количества успехов (числитель при расчете рейтинга).

Требуется, если для параметра useRateMetric установлено значение false.

metricDenominator string УСТАРЕЛО

Метрика общего количества (знаменатель при расчете скорости).

Требуется, если для параметра useRateMetric установлено значение false.

evaluationType string Тип оценки SLO.

Элемент может содержать эти значения

  • AGGREGATE
errorBudgetBurnRate SloBurnRate Ошибка оценки скорости сжигания бюджета для целевого уровня обслуживания (SLO).
evaluatedPercentage number Расчетное значение SLO. Имеет значение оцениваемого SLO или значение -1:
  • Если есть ошибка при расчете SLO; в этом случае проверьте значение свойства ошибки .
  • Если для параметра оценки не установлено значение true; в этом случае свойство error не будет содержать ошибки.
burnRateMetricKey string Ключ скорости сжигания бюджета ошибок для выражения метрики.
errorBudgetMetricKey string Ключ бюджета ошибок для выражения метрики.
normalizedErrorBudgetMetricKey string Ключ нормализованного бюджета ошибок для выражения метрики.
numeratorValue number УСТАРЕЛО

Значение числителя, используемое для оценки SLO, когда для параметра useRateMetric установлено значение false.

denominatorValue number УСТАРЕЛО

Значение знаменателя, используемое для оценки SLO, когда для параметра useRateMetric установлено значение false.

relatedOpenProblems integer Количество ОТКРЫТЫХ проблем, связанных с SLO.

Имеет значение, -1если возникла ошибка при получении проблем, связанных с SLO.

relatedTotalProblems integer Общее количество проблем, связанных с SLO.

Имеет значение, -1если возникла ошибка при получении проблем, связанных с SLO.

hasAccess boolean SLO доступен через настройки, если hasAccess имеет значение true.
errorBudget number Бюджет ошибки рассчитанного SLO.

Бюджет ошибок — это разница между расчетным и целевым значениями. Положительное число означает, что все хорошо; отрицательное число означает проблемы.

metricKey string Ключ для метрического выражения. После создания метрические ключи нельзя изменить.
timeframe string Сроки оценки SLO. Используйте синтаксис глобального селектора таймфреймов.
filter string Фильтр объектов для оценки SLO. Используйте синтаксис селектора объектов .
description string Краткое описание SLO.
enabled boolean SLO включен ( true) или отключен ( false).
status string Статус рассчитанного SLO.

Элемент может содержать эти значения

  • FAILURE
  • SUCCESS
  • WARNING
error string Ошибка расчета SLO.

Если значение отличается от NONE, значит, что-то не так с расчетом SLO.

warning number Предупреждающее значение SLO.

В состоянии предупреждения SLO все еще выполняется, но приближается к отказу.

name string Название SLO.
id string Идентификатор SLO
target number Целевое значение SLO.

Объект SloBurnRate

Ошибка оценки скорости сжигания бюджета для целевого уровня обслуживания (SLO).

Элемент Тип Описание
burnRateVisualizationEnabled boolean Визуализация скорости сжигания бюджета ошибок включена ( true) или отключена ( false).

В случае false, здесь не будет вычисляемых значений.

fastBurnThreshold number Порог между медленной и быстрой скоростью горения.
sloValue number Расчетное значение SLO для таймфрейма, выбранного для расчета скорости выгорания.
estimatedTimeToConsumeErrorBudget number Расчетное время, оставшееся для использования бюджета ошибок в часах.
burnRateType string Расчетный тип скорости горения.

Имеет значение «БЫСТРО», «МЕДЛЕННО» или «НЕТ».

Элемент может содержать эти значения

  • FAST
  • NONE
  • SLOW
burnRateValue number Скорость записи SLO, рассчитанная за последний час.

JSON-модель тела ответа

{
  "problemFilters": "[type(\"SERVICE\")]",
  "metricExpression": "(100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())",
  "useRateMetric": true,
  "metricRate": "builtin:service.successes.server.rate",
  "metricNumerator": "builtin:service.errors.server.successCount",
  "metricDenominator": "builtin:service.requestCount.server",
  "evaluationType": "AGGREGATE",
  "errorBudgetBurnRate": {
    "burnRateVisualizationEnabled": true,
    "fastBurnThreshold": 1.5,
    "sloValue": 95,
    "estimatedTimeToConsumeErrorBudget": 24,
    "burnRateType": "SLOW",
    "burnRateValue": 1.25
  },
  "evaluatedPercentage": 96.25,
  "burnRateMetricKey": "func:slo.errorBudgetBurnRate.payment_service_availability",
  "errorBudgetMetricKey": "func:slo.errorBudget.payment_service_availability",
  "normalizedErrorBudgetMetricKey": "func:slo.normalizedErrorBudget.payment_service_availability",
  "numeratorValue": 80,
  "denominatorValue": 90,
  "relatedOpenProblems": 1,
  "relatedTotalProblems": 1,
  "hasAccess": true,
  "errorBudget": 1.25,
  "metricKey": "func:slo.payment_service_availability",
  "timeframe": "-1d",
  "filter": "type(\"SERVICE\")",
  "description": "Rate of successful payments per week",
  "enabled": true,
  "status": "WARNING",
  "error": "NONE",
  "warning": 97.5,
  "name": "Payment service availability",
  "id": "123e4567-e89b-42d3-a456-556642440000",
  "target": 95
}
Источник — https://doc.ruscomtech.ru/index.php?title=GET_один_SLO&oldid=1817