Удаление пользовательской метрики (2): различия между версиями

Материал из Документация Ключ-АСТРОМ
 
Строка 5: Строка 5:


{| class="wikitable"
{| class="wikitable"
| rowspan="3" |УДАЛИТЬ
| rowspan="2" |DELETE
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|-
|-
|SaaS
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/{metricKey}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/metrics/{metricKey}</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 27: Строка 24:
!Необходимость
!Необходимость
|-
|-
|метрикей
|metricKey
|string
|string
|Ключ требуемой метрики.
|Ключ требуемой метрики.
|дорожка
|path
|требуется
|требуется
|}
|}
Строка 53: Строка 50:
|Не удалось. Не удалось удалить параметры показателей.
|Не удалось. Не удалось удалить параметры показателей.
|}
|}
== Пример ==
В этом примере запрос удаляет показатель cpu.temperature. Код ответа 202 указывает на то, что удаление было успешно запущено.
Токен API передается в заголовке авторизации.
==== Curl ====
<code>curl --request DELETE \
  --url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature</nowiki> \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature</nowiki></code>
==== Код ответа ====
202

Текущая версия на 14:07, 10 октября 2022

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

  • Вы не можете удалить метрику, если она содержит точки данных, полученные в течение последних двух часов.
  • Вы можете удалять только те метрики, которые были загружены через 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}

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия 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