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

2025-01-02T16:45:31Z

← Предыдущая версия		Версия от 16:45, 2 января 2025
Строка 1:		Строка 1:
			'''''[[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)] / POST один SLO'''''

	Создает новую цель уровня обслуживания (SLO).		Создает новую цель уровня обслуживания (SLO).

Строка 162:		Строка 164:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"enabled": true,		"enabled": true,
	"name": "Payment service availability",		"name": "Payment service availability",

ENetrebin: Новая страница: «Создает новую цель уровня обслуживания (SLO). Запрос использует в качестве полезной нагру...»

2022-10-19T14:56:54Z

Новая страница: «Создает новую цель уровня обслуживания (SLO). Запрос использует в качестве полезной нагру...»

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

Создает новую цель уровня обслуживания (SLO).

Запрос использует в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |POST
|Удалось
|<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>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|Slo Config Item Dto Impl
|Тело JSON запроса. Содержит параметры нового SLO.
|body
|требуется
|}

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

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

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

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

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

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"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"
}</code>

== Ответ ==

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

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

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

ENetrebin: Новая страница: «Создает новую цель уровня обслуживания (SLO). Запрос использует в качестве полезной нагру...»