Удаление пользовательской метрики (2): различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 5: | Строка 5: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | 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> | ||
|- | |- | ||
| | |Cреда АктивногоШлюза | ||
|<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)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 24: | Строка 21: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |metricKey | ||
| | |string | ||
|Ключ требуемой метрики. | |Ключ требуемой метрики. | ||
| | |path | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 55: | Строка 52: | ||
== Пример == | == Пример == | ||
В этом примере запрос удаляет | В этом примере запрос удаляет показатель cpu.temperature. Код ответа 202 указывает на то, что удаление было успешно запущено. | ||
Токен API передается в заголовке авторизации. | |||
==== Curl ==== | ==== Curl ==== | ||
<code>curl --request DELETE \ | <code>curl --request DELETE \ | ||
--url <nowiki>https://mySampleEnv.live. | --url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics/cpu.temperature</nowiki></code> | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
202 | 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
