IKuznetsov в 16:44, 2 января 2025

2025-01-02T16:44:49Z

← Предыдущая версия		Версия от 16:44, 2 января 2025
Строка 1:		Строка 1:
	'''''API АппОптима / [https://~~doc~~.~~ruscomtech~~.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%~~87-~~%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%~~9C#.~~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 Развёртывание] / Цели уровня обслуживания (SLO) / GET все SLO'''''		'''''[[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%A6%D0%B5%D0%BB%D0%B8%20%D1%83%D1%80%D0%BE%D0%B2%D0%BD%D1%8F%20%D0%BE%D0%B1%D1%81%D0%BB%D1%83%D0%B6%D0%B8%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20(SLO) Цели уровня обслуживания (SLO)] / GET все SLO'''''

	Перечисляет все цели уровня обслуживания и их расчетные значения.		Перечисляет все цели уровня обслуживания и их расчетные значения.
Строка 469:		Строка 469:
	"pageSize": 1,		"pageSize": 1,
	"totalCount": 1		"totalCount": 1
	}~~</code>~~		}

IKuznetsov в 10:14, 26 декабря 2024

2024-12-26T10:14:40Z

← Предыдущая версия		Версия от 10:14, 26 декабря 2024
Строка 1:		Строка 1:
	'''''API ~~Ключ-АСТРОМ~~ / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.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 Развёртывание] / Цели уровня обслуживания (SLO) / GET все SLO'''''		'''''API АппОптима / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.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 Развёртывание] / Цели уровня обслуживания (SLO) / GET все SLO'''''

	Перечисляет все цели уровня обслуживания и их расчетные значения.		Перечисляет все цели уровня обслуживания и их расчетные значения.
Строка 11:		Строка 11:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/slo</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/slo</nowiki></code>
	\|-		\|-
Строка 425:		Строка 425:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"slo": [		"slo": [
	{		{

ENetrebin в 18:16, 14 октября 2024

2024-10-14T18:16:08Z

← Предыдущая версия		Версия от 18:16, 14 октября 2024
Строка 1:		Строка 1:
			'''''API Ключ-АСТРОМ / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.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 Развёртывание] / Цели уровня обслуживания (SLO) / GET все SLO'''''

	Перечисляет все цели уровня обслуживания и их расчетные значения.		Перечисляет все цели уровня обслуживания и их расчетные значения.

ENetrebin: Новая страница: «Перечисляет все цели уровня обслуживания и их расчетные значения. По умолчанию значени...»

2022-10-19T14:25:53Z

Новая страница: «Перечисляет все цели уровня обслуживания и их расчетные значения. По умолчанию значени...»

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

Перечисляет все цели уровня обслуживания и их расчетные значения.

По умолчанию значения рассчитываются для собственного таймфрейма SLO. Вы можете использовать пользовательский таймфрейм:

# Установите для параметра timeFrame<code>GTF</code> значение .
# Укажите временные рамки в параметрах from и to .

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|query
|по желанию
|-
|pageSize
|integer
|Количество SLO в полезной нагрузке одного ответа.

Максимально допустимый размер страницы — 10000.

Если не установлено, используется 10.
|query
|по желанию
|-
|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
|по желанию
|-
|sloSelector
|string
|Объем запроса. В ответ включаются только SLO, соответствующие заданным критериям.

Вы можете добавить один или несколько из перечисленных ниже критериев.

* Идентификатор: идентификатор ("идентификатор"). Фильтры для SLO с заданным идентификатором.
* Имя: имя("имя"). Фильтры для SLO с заданным названием. Фильтр чувствителен к регистру.
* Состояние работоспособности: HealthState("ЗДОРОВО") или HealthState("НЕЗДОРОВО"). Можно указать только одно состояние работоспособности.
* Текст: текст ("значение"). Фильтры для всех SLO, которые содержат данное значение в своем имени или описании. Фильтр нечувствителен к регистру.
* Проблема: имя_проблемы("значение"). Фильтры для всех SLO, связанных с данным отображаемым именем проблемы (например, P-12345).

Чтобы задать несколько критериев, разделите их запятой (,). В ответ включаются только результаты, соответствующие всем критериям. например, .../api/v2/slo?sloSelector=name("Доступность службы"), .../api/v2/slo?sloSelector=id("id"), .../api/v2/slo ?sloSelector=текст("Описание"),healthState("ЗДОРОВО").

Специальные символы ~ и " необходимо экранировать с помощью символа ~ (например, текст поиска в двойных кавычках ("~"").
|query
|по желанию
|-
|sort
|string
|Сортировка записей SLO:

* <code>name</code>: Имена в порядке возрастания.
* <code>-name</code>: Имена в порядке убывания.

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

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

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

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

* <code>CURRENT</code>
* <code>GTF</code>
|query
|по желанию
|-
|demo
|boolean
|Получите свои SLO ( <code>false</code>) или набор демонстрационных SLO ( <code>true</code>).
|query
|по желанию
|-
|evaluate
|boolean
|Получите SLO без их оценки ( <code>false</code>) или с оценками ( <code>true</code>) с максимальным <code>pageSize</code>количеством 25.
|query
|по желанию
|-
|enabledSlos
|string
|Получите включенные SLO ( <code>true</code>), отключенные ( <code>false</code>) или как включенные, так и отключенные ( <code>all</code>).

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

* <code>true</code>
* <code>false</code>
* <code>all</code>
|query
|по желанию
|-
|showGlobalSlos
|boolean
|Получите свои глобальные SLO ( <code>true</code>) независимо от выбранного фильтра или отфильтруйте их ( <code>false</code>).
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>SLOs</code> ====
Содержит SLO и пейджинговую информацию.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|slo
|SLO[]
|Список SLO.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|pageSize
|integer
|Количество записей на странице.
|-
|totalCount
|integer
|Общее количество записей в результате.
|}

==== Объект <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>{
"slo": [
{
"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
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 1,
"totalCount": 1
}</code>

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

IKuznetsov в 16:44, 2 января 2025

IKuznetsov в 10:14, 26 декабря 2024

ENetrebin в 18:16, 14 октября 2024

ENetrebin: Новая страница: «Перечисляет все цели уровня обслуживания и их расчетные значения. По умолчанию значени...»