API Ключ-АСТРОМ / Эндпойнты среды / Пользовательские теги / DELETE тегов
Данная функция удаляет указанный пользовательский тег из указанных отслеживаемых объектов.
Запрос создает application/json
полезную нагрузку.
DELETE
|
Managed
|
https://{your-domain}/e/{your-environment-id}/api/v2/tags
|
Среда АктивногоШлюза
|
https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на запись объектов ( entities.write
) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр
|
Тип
|
Описание
|
In
|
Необходимость
|
key
|
string
|
Ключ удаляемого тега.
Если deleteAllWithKey равно true , то удаляются все теги с этим ключом. В противном случае удаляются только теги с точным соответствием ключа и значения.
Для тегов только со значением укажите значение здесь.
|
запрос
|
требуется
|
value
|
string
|
Значение удаляемого тега. Значение игнорируется, если для deleteAllWithKey установлено значение true .
Для тегов только со значением укажите значение в ключевом параметре.
|
запрос
|
необязательный
|
deleteAllWithKey
|
boolean
|
- Если
true , удаляются все теги с указанным ключом, независимо от значения.
- Если , удаляются
false только теги с точным соответствием ключа и значения.
Если не установлено, false используется.
|
запрос
|
необязательный
|
entitySelector
|
string
|
Указывает сущности, для которых вы хотите удалить теги.
Вы должны установить один из этих критериев:
- Тип объекта:
type("TYPE")
- Идентификатор объекта Ключ-Астром:
entityId("id") . Вы можете указать несколько идентификаторов, разделенных запятой ( entityId("id-1","id-2") ). Все запрошенные сущности должны быть одного типа.
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и EQUALS оператор используется, если не указано иное.
- Тег:
tag("value") . Теги в форматах [context]key:value , key:value и value обнаруживаются и анализируются автоматически. Любые двоеточия ( : ), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( \ ), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.
- Идентификатор зоны управления:
mzId(123)
- Название зоны управления:
mzName("value")
- Имя объекта:
entityName("value") . По умолчанию это фильтрует объекты, имя которых содержит заданное значение и не чувствительно к регистру. Доступны следующие модификации:
entityName.equals : изменяет оператор на EQUALS .
entityName.startsWith : изменяет оператор на BEGINS WITH .
entityName.in : позволяет указать несколько значений. Оператор EQUALS обращается.
caseSensitive(entityName("value")) : принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.
- Состояние здоровья (ЗДОРОВЫЙ, НЕЗДОРОВЫЙ):
healthState("HEALTHY")
- Отметка времени первого увиденного:
firstSeenTms.<operator>(now-3h) . Используйте любой формат метки времени из параметров from / to . Доступны следующие операторы:
lte : раньше или в указанное время
lt : раньше указанного времени
gte : позже или в указанное время
gt : позже указанного времени
- Атрибут объекта:
<attribute>("value1","value2") и <attribute>.exists() . Чтобы получить список доступных атрибутов, выполните запрос типа сущности GET и проверьте поле свойств ответа.
- Отношения:
fromRelationships.<relationshipName>() и toRelationships.<relationshipName>() . Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа сущности GET и проверьте поля fromRelationships и toRelationships .
- Отрицание:
not(<criterion>) . Инвертирует любой критерий, кроме type .
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-Астром.
Чтобы задать несколько критериев, разделите их запятой ( , ). Например, type("HOST"),healthState("HEALTHY") . В ответ включаются только результаты, соответствующие всем критериям.
Длина строки ограничена 10 000 символов.
|
запрос
|
требуется
|
from
|
string
|
Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
- Отметка времени в миллисекундах UTC.
- Читаемый формат
2021-01-25T05:57:01.123+01:00 . Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T . Секунды и доли секунды не являются обязательными.
- Относительный таймфрейм, назад. Формат:
now-NU/A , где N количество времени, U единица времени и A выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/w это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU . Поддерживаемые единицы времени для относительного таймфрейма:
m : минуты
h : часы
d : дни
w : недели
M : месяцы
y : годы
Если не установлено, используется относительный временной интервал 24 часа ( now-24h ).
|
запрос
|
необязательный
|
to
|
string
|
Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
- Отметка времени в миллисекундах UTC.
- Человекочитаемый формат
2021-01-25T05:57:01.123+01:00 . Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T . Секунды и доли секунды не являются обязательными.
- Относительный таймфрейм, назад. Формат:
now-NU/A , где N количество времени, U единица времени и A выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/w это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU . Поддерживаемые единицы времени для относительного таймфрейма:
m : минут
h : часы
d : дней
w : недели
M : месяцы
y : годы
Если не установлено, используется текущая метка времени.
|
запрос
|
необязательный
|
Ответ
Коды ответов
Код
|
Тип
|
Описание
|
200
|
DeletedEntityTags
|
Успех
|
Объекты тела ответа
Объект DeletedEntityTags
Удален пользовательский тег.
Элемент
|
Тип
|
Описание
|
matchedEntitiesCount
|
integer
|
Количество отслеживаемых объектов, где тег был удален.
Может быть null .
|
JSON-модель тела ответа
{
"matchedEntitiesCount": 2
}
Пример
В этом примере запрос удаляет пользовательский тег REST-test , созданный в примере запроса POST ( key=REST-test
). Параметр запроса entitySelector снова имеет значение type("HOST"),tag("easyTravel")
.
Маркер API передается в заголовке авторизации.
Curl
curl -L -X DELETE 'https://mySampleEnv.live.astromkey.com/api/v2/tags?entitySelector=type(%22HOST%22)%2Ctag(%22easyTrave%22)&key=REST-test' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.astromkey.com/api/v2/tags?entitySelector=type(%22HOST%22)%2Ctag(%22easyTrave%22)&key=REST-test
Тело ответа
{
"matchedEntitiesCount": 3
}
Код ответа
200