ENetrebin в 16:35, 9 февраля 2023

2023-02-09T16:35:53Z

← Предыдущая		Версия 16:35, 9 февраля 2023
Строка 9:		Строка 9:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>
	\|-		\|-
	\|Cреда ~~АктивногоШлюза~~		\|Cреда ActiveGate
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>
	\|}		\|}

ENetrebin: Новая страница: «Получает параметр указанной цели уровня обслуживания (SLO). Если указаны параметры from и to...»

2022-10-19T14:46:25Z

Новая страница: «Получает параметр указанной цели уровня обслуживания (SLO). Если указаны параметры from и to...»

Новая страница

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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>
|-
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/slo/{id}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read SLO ( <code>slo.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|from
|string
|Начало запрошенного таймфрейма.

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

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

Если не задано, используется относительный двухнедельный таймфрейм ( <code>now-2w</code>).
|query
|по желанию
|-
|to
|string
|Конец запрошенного периода времени.

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

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

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|id
|string
|Идентификатор требуемого SLO.
|path
|требуется
|-
|timeFrame
|string
|Таймфрейм для расчета значений SLO:

* <code>CURRENT</code>: собственный таймфрейм SLO.
* <code>GTF</code>: период времени, заданный параметрами from и to .

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

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

* <code>CURRENT</code>
* <code>GTF</code>
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>SLO</code> ====
Параметры целевого уровня обслуживания (SLO).
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|<s>problemFilters</s>
|string[]
|УСТАРЕЛО

Фильтр сущностей для получения количества проблем, связанных с SLO. Генерируется автоматически, если в SLO не был добавлен фильтр.
|-
|metricExpression
|string
|Процентное выражение метрики для расчета SLO.
|-
|<s>useRateMetric</s>
|boolean
|УСТАРЕЛО

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

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

Список доступных метрик см. на странице встроенных метрик или попробуйте вызов API GET метрик .
|-
|<s>metricRate</s>
|string
|УСТАРЕЛО

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

Требуется, если для параметра useRateMetric установлено значение <code>true</code>.
|-
|<s>metricNumerator</s>
|string
|УСТАРЕЛО

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

Требуется, если для параметра useRateMetric установлено значение <code>false</code>.
|-
|<s>metricDenominator</s>
|string
|УСТАРЕЛО

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

Требуется, если для параметра useRateMetric установлено значение <code>false</code>.
|-
|evaluationType
|string
|Тип оценки SLO.

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

* <code>AGGREGATE</code>
|-
|errorBudgetBurnRate
|SloBurnRate
|Ошибка оценки скорости сжигания бюджета для целевого уровня обслуживания (SLO).
|-
|evaluatedPercentage
|number
|Расчетное значение SLO. Имеет значение оцениваемого SLO или значение <code>-1</code>:

* Если есть ошибка при расчете SLO; в этом случае проверьте значение свойства ошибки .
* Если для параметра оценки не установлено значение <code>true</code>; в этом случае свойство error не будет содержать ошибки.
|-
|burnRateMetricKey
|string
|Ключ скорости сжигания бюджета ошибок для выражения метрики.
|-
|errorBudgetMetricKey
|string
|Ключ бюджета ошибок для выражения метрики.
|-
|normalizedErrorBudgetMetricKey
|string
|Ключ нормализованного бюджета ошибок для выражения метрики.
|-
|<s>numeratorValue</s>
|number
|УСТАРЕЛО

Значение числителя, используемое для оценки SLO, когда для параметра useRateMetric установлено значение <code>false</code>.
|-
|<s>denominatorValue</s>
|number
|УСТАРЕЛО

Значение знаменателя, используемое для оценки SLO, когда для параметра useRateMetric установлено значение <code>false</code>.
|-
|relatedOpenProblems
|integer
|Количество ОТКРЫТЫХ проблем, связанных с SLO.

Имеет значение, <code>-1</code>если возникла ошибка при получении проблем, связанных с SLO.
|-
|relatedTotalProblems
|integer
|Общее количество проблем, связанных с SLO.

Имеет значение, <code>-1</code>если возникла ошибка при получении проблем, связанных с SLO.
|-
|hasAccess
|boolean
|SLO доступен через настройки, если hasAccess имеет значение <code>true</code>.
|-
|errorBudget
|number
|Бюджет ошибки рассчитанного SLO.

Бюджет ошибок — это разница между расчетным и целевым значениями. Положительное число означает, что все хорошо; отрицательное число означает проблемы.
|-
|metricKey
|string
|Ключ для метрического выражения. После создания метрические ключи нельзя изменить.
|-
|timeframe
|string
|Сроки оценки SLO. Используйте синтаксис глобального селектора таймфреймов.
|-
|filter
|string
|Фильтр объектов для оценки SLO. Используйте синтаксис селектора объектов .
|-
|description
|string
|Краткое описание SLO.
|-
|enabled
|boolean
|SLO включен ( <code>true</code>) или отключен ( <code>false</code>).
|-
|status
|string
|Статус рассчитанного SLO.

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

* <code>FAILURE</code>
* <code>SUCCESS</code>
* <code>WARNING</code>
|-
|error
|string
|Ошибка расчета SLO.

Если значение отличается от <code>NONE</code>, значит, что-то не так с расчетом SLO.
|-
|warning
|number
|Предупреждающее значение SLO.

В состоянии предупреждения SLO все еще выполняется, но приближается к отказу.
|-
|name
|string
|Название SLO.
|-
|id
|string
|Идентификатор SLO
|-
|target
|number
|Целевое значение SLO.
|}

==== Объект <code>SloBurnRate</code> ====
Ошибка оценки скорости сжигания бюджета для целевого уровня обслуживания (SLO).
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|burnRateVisualizationEnabled
|boolean
|Визуализация скорости сжигания бюджета ошибок включена ( <code>true</code>) или отключена ( <code>false</code>).

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

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

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

* <code>FAST</code>
* <code>NONE</code>
* <code>SLOW</code>
|-
|burnRateValue
|number
|Скорость записи SLO, рассчитанная за последний час.
|}

=== JSON-модель тела ответа ===
<code>{
"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
}</code>

GET один SLO - История изменений

ENetrebin в 16:35, 9 февраля 2023

ENetrebin: Новая страница: «Получает параметр указанной цели уровня обслуживания (SLO). Если указаны параметры from и to...»