DELETE пользовательской метрики

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

Удаляет указанную пользовательскую добавленную метрику . Удаление не может быть отменено!

  • Вы не можете удалить метрику, если она содержит точки данных, полученные в течение последних двух часов.
  • Вы можете удалять только те метрики, которые были загружены через API Metrics v2.
DELETE Managed https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}

Содержание

  • 1Аутентификация
  • 2Параметры
  • 3Ответ
    • 3.1Коды ответов
  • 4Пример
    • 4.1Curl
    • 4.2URL-адрес запроса
    • 4.3Код ответа

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

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

Параметры

Параметр Тип Описание In Необходимость
metricKey string Ключ требуемой метрики. path требуется

Ответ

Коды ответов

Код Описание
202 Успех. Инициировано удаление показателя.
400 Не удалось. Метрика была записана в течение последних двух часов.
404 Не удалось. Метрика не может быть найдена или ключ не может быть проанализирован.
500 Не удалось. Не удалось удалить параметры показателей.

Пример

В этом примере запрос удаляет показатель cpu.temperature. Код ответа 202 указывает на то, что удаление было успешно запущено.

Токен API передается в заголовке авторизации.

Curl

curl --request DELETE \
  --url https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature

Код ответа

202