Получение тегов - История изменений

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

2023-01-24T14:51:15Z

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

	* Тип объекта:<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>оператор используется, если не указано иное.
Строка 54:		Строка 54:
	* Отрицание: <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 в 13:47, 10 марта 2022

2022-03-10T13:47:23Z

← Предыдущая		Версия 13:47, 10 марта 2022
Строка 42:		Строка 42:
	** <code>entityName.equals</code>: изменяет оператор на <code>EQUALS</code>.		** <code>entityName.equals</code>: изменяет оператор на <code>EQUALS</code>.
	** <code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.		** <code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.
	** <code>entityName.in</code>: позволяет указать несколько значений. ~~Оператор~~ <code>EQUALS</code>~~обращается~~.		** <code>entityName.in</code>: позволяет указать несколько значений. Применяется оператор <code>EQUALS</code>.
	** <code>caseSensitive(entityName("value"))</code>: принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.		** <code>caseSensitive(entityName("value"))</code>: принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.
	* Состояние здоровья (ЗДОРОВЫЙ, НЕЗДОРОВЫЙ):<code>healthState("HEALTHY")</code>		* Состояние здоровья (ЗДОРОВЫЙ, НЕЗДОРОВЫЙ):<code>healthState("HEALTHY")</code>
Строка 71:		Строка 71:
	* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.		* Человекочитаемый формат <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>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>m</code>: минуты
	** <code>h</code>: часы		** <code>h</code>: часы
	** <code>d</code>: ~~дней~~		** <code>d</code>: дни
	** <code>w</code>: недели		** <code>w</code>: недели
	** <code>M</code>: месяцы		** <code>M</code>: месяцы
Строка 89:		Строка 89:

	* Отметка времени в миллисекундах UTC.		* Отметка времени в миллисекундах UTC.
	* ~~Человекочитаемый~~ формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.		* Читаемый формат <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>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>m</code>: минуты
	** <code>h</code>: часы		** <code>h</code>: часы
	** <code>d</code>: ~~дней~~		** <code>d</code>: дни
	** <code>w</code>: недели		** <code>w</code>: недели
	** <code>M</code>: месяцы		** <code>M</code>: месяцы

ENetrebin: Новая страница: «Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаем...»

2022-03-10T11:09:08Z

Новая страница: «Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаем...»

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

Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |GET
|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.read</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|entitySelector
|string
|Указывает объекты, в которых вы хотите прочитать теги.

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

* Тип объекта:<code>type("TYPE")</code>
* Идентификатор объекта Ключ-АСТРОМ: <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 .

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

Чтобы задать несколько критериев, разделите их запятой ( <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
|CustomEntityTags
|Успех
|}

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

==== Объект _ <code>CustomEntityTags</code> ====
Список пользовательских тегов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|totalCount
|integer
|Общее количество тегов в ответе.

Может быть <code>null</code>.
|-
|tags
|METag[]
|Список пользовательских тегов.
|}

==== Объект _ <code>METag</code> ====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|stringRepresentation
|string
|Строковое представление тега.

Может быть <code>null</code>.
|-
|value
|string
|Значение тега.

Может быть <code>null</code>.
|-
|key
|string
|Ключ тега.

Может быть <code>null</code>.
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

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

=== JSON-модель тела ответа ===
<code>{
"totalCount": 2,
"tags": [
{
"context": "CONTEXTLESS",
"key": "mainApp",
"stringRepresentation": "mainApp"
},
{
"context": "CONTEXTLESS",
"key": "bookings",
"stringRepresentation": "bookings"
}
]
}</code>

== Пример ==
В этом примере в запросе перечислены настраиваемые теги, которые применяются к службам, принадлежащим зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваивается<code>type("SERVICE"),mzId("9130632296508575249")</code> значение .

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

Поскольку полный результат довольно длинный, он усечен до трех записей.

==== Curl ====
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)</nowiki></code>

==== Тело ответа ====
<code>{
"totalCount": 31,
"tags": [
{
"context": "CONTEXTLESS",
"key": "Billing",
"stringRepresentation": "Billing"
},
{
"context": "CONTEXTLESS",
"key": "Booking",
"stringRepresentation": "Booking"
},
{
"context": "CONTEXTLESS",
"key": "easytravel",
"value": "backend",
"stringRepresentation": "easytravel:backend"
}
]
}</code>

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