Удаление пользовательской метрики: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
Встроенные показатели нельзя удалить. | Встроенные показатели нельзя удалить. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |DELETE | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code> | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивныйШлюз | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 22: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |ИtimeseriesIdentifier | ||
| | |string | ||
|Идентификатор метрики, которую необходимо удалить. | |Идентификатор метрики, которую необходимо удалить. | ||
| | |path | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 40: | Строка 40: | ||
|- | |- | ||
|204 | |204 | ||
|Успех. | |Успех. Пользовательская метрика удалена. | ||
|} | |} | ||
| Строка 50: | Строка 50: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl -X DELETE \ | <code>curl -X DELETE \ | ||
<nowiki>https://mySampleEnv.live. | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped</nowiki></code> | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 | ||
Текущая версия на 12:14, 7 октября 2022
Удаляет указанную пользовательскую метрику. Если вы удалите определение метрики, вы потеряете все данные этой метрики, поэтому будьте осторожны с удалением.
Встроенные показатели нельзя удалить.
| DELETE | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}
|
| SaaS | https://{your-environment-id}.live.ruscomtech.ru/api/v1/timeseries/{timeseriesIdentifier}
| |
| Окружающая среда АктивныйШлюз | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| ИtimeseriesIdentifier | string | Идентификатор метрики, которую необходимо удалить. | path | требуется |
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Успех. Пользовательская метрика удалена. |
Пример
В этом примере запрос удаляет пользовательскую метрику custom:firewall.connections.dropped .
Маркер API передается в заголовке авторизации .
Curl
curl -X DELETE \
https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped
Код ответа
204
