Удаление тегов - История изменений

ENetrebin в 14:53, 24 января 2023

2023-01-24T14:53:12Z

← Предыдущая		Версия 14:53, 24 января 2023
Строка 60:		Строка 60:

	* Тип объекта:<code>type("TYPE")</code>		* Тип объекта:<code>type("TYPE")</code>
	* Идентификатор объекта ~~Ключ-Астром~~: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.		* Идентификатор объекта Dynatrace: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.

	Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.		Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.
Строка 82:		Строка 82:
	* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .		* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .

	Дополнительные сведения см. в разделе Селектор объектов в документации ~~Ключ-Астром~~.		Дополнительные сведения см. в разделе Селектор объектов в документации Dynatrace.

	Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.		Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.

ENetrebin: /* Объект _ DeletedEntityTags */

2022-08-12T06:46:23Z

Объект _ DeletedEntityTags

← Предыдущая		Версия 06:46, 12 августа 2022
Строка 168:		Строка 168:
	В этом примере запрос удаляет пользовательский тег REST-test , созданный в примере запроса POST ( <code>key=REST-test</code>). Параметр запроса entitySelector снова имеет значение <code>type("HOST"),tag("easyTravel")</code>.		В этом примере запрос удаляет пользовательский тег REST-test , созданный в примере запроса POST ( <code>key=REST-test</code>). Параметр запроса entitySelector снова имеет значение <code>type("HOST"),tag("easyTravel")</code>.

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

	==== Curl ====		==== Curl ====

Lobanov: /* Параметры */

2022-03-15T16:01:36Z

Параметры

← Предыдущая		Версия 16:01, 15 марта 2022
Строка 60:		Строка 60:

	* Тип объекта:<code>type("TYPE")</code>		* Тип объекта:<code>type("TYPE")</code>
	* Идентификатор объекта ~~Dynatrace~~: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.		* Идентификатор объекта Ключ-Астром: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.

	Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.		Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.
Строка 82:		Строка 82:
	* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .		* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .

	Дополнительные сведения см. в разделе Селектор объектов в документации ~~Dynatrace~~.		Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-Астром.

	Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.		Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.

ENetrebin: Новая страница: «Данная функция удаляет указанный пользовательский тег из указанных отслеживаемых объе...»

2022-03-10T15:07:35Z

Новая страница: «Данная функция удаляет указанный пользовательский тег из указанных отслеживаемых объе...»

Новая страница

Данная функция удаляет указанный пользовательский тег из указанных отслеживаемых объектов.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |DELETE
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/tags</nowiki></code>
|-
|Environment АктивныйШлюз
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|key
|string
|Ключ удаляемого тега.

Если deleteAllWithKey равно <code>true</code>, то удаляются все теги с этим ключом. В противном случае удаляются только теги с точным соответствием ключа и значения.

Для тегов только со значением укажите значение здесь.
|запрос
|требуется
|-
|value
|string
|Значение удаляемого тега. Значение игнорируется, если для deleteAllWithKey установлено значение <code>true</code>.

Для тегов только со значением укажите значение в ключевом параметре.
|запрос
|необязательный
|-
|deleteAllWithKey
|boolean
|
* Если <code>true</code>, удаляются все теги с указанным ключом, независимо от значения.
* Если , удаляются <code>false</code>только теги с точным соответствием ключа и значения.

Если не установлено, <code>false</code>используется.
|запрос
|необязательный
|-
|entitySelector
|string
|Указывает сущности, для которых вы хотите удалить теги.

Вы должны установить один из этих критериев:

* Тип объекта:<code>type("TYPE")</code>
* Идентификатор объекта Dynatrace: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.

Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.

* Тег: <code>tag("value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Любые двоеточия ( <code>:</code>), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( <code>\</code>), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.
* Идентификатор зоны управления:<code>mzId(123)</code>
* Название зоны управления:<code>mzName("value")</code>
* Имя объекта: <code>entityName("value")</code>. По умолчанию это фильтрует объекты, имя которых содержит заданное значение и не чувствительно к регистру. Доступны следующие модификации:
** <code>entityName.equals</code>: изменяет оператор на <code>EQUALS</code>.
** <code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.
** <code>entityName.in</code>: позволяет указать несколько значений. Оператор <code>EQUALS</code>обращается.
** <code>caseSensitive(entityName("value"))</code>: принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.
* Состояние здоровья (ЗДОРОВЫЙ, НЕЗДОРОВЫЙ):<code>healthState("HEALTHY")</code>
* Отметка времени первого увиденного: <code>firstSeenTms.<operator>(now-3h)</code>. Используйте любой формат метки времени из параметров from / to . Доступны следующие операторы:
** <code>lte</code>: раньше или в указанное время
** <code>lt</code>: раньше указанного времени
** <code>gte</code>: позже или в указанное время
** <code>gt</code>: позже указанного времени
* Атрибут объекта: <code><attribute>("value1","value2")</code>и <code><attribute>.exists()</code>. Чтобы получить список доступных атрибутов, выполните запрос типа сущности GET и проверьте поле свойств ответа.
* Отношения: <code>fromRelationships.<relationshipName>()</code>и <code>toRelationships.<relationshipName>()</code>. Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа сущности GET и проверьте поля fromRelationships и toRelationships .
* Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .

Дополнительные сведения см. в разделе Селектор объектов в документации Dynatrace.

Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.

Длина строки ограничена 10 000 символов.
|запрос
|требуется
|-
|from
|string
|Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Читаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется относительный временной интервал 24 часа ( <code>now-24h</code>).
|запрос
|необязательный
|-
|to
|string
|Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минут
** <code>h</code>: часы
** <code>d</code>: дней
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|запрос
|необязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|DeletedEntityTags
|Успех
|}

=== Объекты тела ответа ===

==== Объект _ <code>DeletedEntityTags</code> ====
Удален пользовательский тег.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|matchedEntitiesCount
|integer
|Количество отслеживаемых объектов, где тег был удален.

Может быть <code>null</code>.
|}

=== JSON-модель тела ответа ===
<code>{
"matchedEntitiesCount": 2
}</code>

== Пример ==
В этом примере запрос удаляет пользовательский тег REST-test , созданный в примере запроса POST ( <code>key=REST-test</code>). Параметр запроса entitySelector снова имеет значение <code>type("HOST"),tag("easyTravel")</code>.

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

==== Curl ====
<code>curl -L -X DELETE '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22)%2Ctag(%22easyTrave%22)&key=REST-test'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22)%2Ctag(%22easyTrave%22)&key=REST-test</nowiki></code>

==== Тело ответа ====
<code>{
"matchedEntitiesCount": 3
}</code>

==== Код ответа ====
200