PUT один SLO

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

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

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор требуемого SLO. path требуется
body Slo Config Item Dto Impl Тело JSON запроса. Содержит обновленные параметры SLO. body требуется

Объекты тела запроса

Объект SloConfigItemDtoImpl

Элемент Тип Описание Необходимость
enabled boolean SLO включен ( true) или отключен ( false). по желанию
name string Название SLO. по желанию
description string Описание SLO (необязательно). по желанию
metricName string Имя выражения метрики по желанию
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
по желанию
filter string Фильтр объектов для оценки SLO. Используйте синтаксис селектора объектов . по желанию
target number Целевое значение SLO. по желанию
warning number Предупреждающее значение SLO.

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

по желанию
errorBudgetBurnRate SloBurnRateConfig Ошибка конфигурации расхода бюджета для цели уровня обслуживания (SLO). по желанию
timeframe string Сроки оценки SLO. Используйте синтаксис глобального селектора таймфреймов. по желанию

Объект SloBurnRateConfig

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

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

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

по желанию
fastBurnThreshold number Порог между медленной и быстрой скоростью горения. по желанию

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "enabled": true,
  "name": "Payment service availability",
  "description": "Rate of successful payments per week",
  "metricName": "payment_service_availability",
  "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",
  "filter": "type(\"SERVICE\")",
  "target": 95,
  "warning": 97.5,
  "errorBudgetBurnRate": {
    "burnRateVisualizationEnabled": true,
    "fastBurnThreshold": 1.5
  },
  "timeframe": "-1d"
}

Ответ

Коды ответов

Код Тип Описание
200 - Успех
400 ErrorEnvelope Не удалось. Ввод недействителен.
404 Не удалось. Запрошенный ресурс не существует.
500 ErrorEnvelope Внутренняя ошибка сервера.