GET теги - История изменений

IKuznetsov в 14:13, 24 декабря 2024

2024-12-24T14:13:41Z

← Предыдущая версия		Версия от 14:13, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [~~[API АппОптима~~#:~:text=~~информацию о кластере~~-,~~Пользовательские теги~~,-~~править\|~~Пользовательские теги]] / GET теги'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8E%20%D0%BE%20%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B5-,%D0%9F%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D0%BA%D0%B8%D0%B5%20%D1%82%D0%B5%D0%B3%D0%B8,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Пользовательские теги] / GET теги'''''

	Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.		Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.
Строка 160:		Строка 160:
	}		}
	]		]
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере в запросе перечислены настраиваемые теги, которые применяются к службам, принадлежащим зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваивается<code>type("SERVICE"),mzId("9130632296508575249")</code> значение .		В этом примере в запросе перечислены настраиваемые теги, которые применяются к службам, принадлежащим зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваивается<code>type("SERVICE"),mzId("9130632296508575249")</code> значение .
Строка 169:		Строка 169:
	====Curl====		====Curl====
	<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)</nowiki></code>
Строка 193:		Строка 193:
	}		}
	]		]
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	200		200

IKuznetsov в 12:24, 24 декабря 2024

2024-12-24T12:24:57Z

← Предыдущая версия		Версия от 12:24, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / [[API ~~Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B~~\|Эндпойнты среды]] / [~~https~~:~~//doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87~~-~~%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9F.D0.BE.D0.BB.D1.8C.D0.B7.D0.BE.D0.B2.D0.B0.D1.82.D0.B5.D0.BB.D1.8C.D1.81.D0.BA.D0.B8.D0.B5_.D1.82.D0.B5.D0.B3.D0.B8~~ Пользовательские теги] / GET теги'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [[API АппОптима#:~:text=информацию о кластере-,Пользовательские теги,-править\|Пользовательские теги]] / GET теги'''''

	Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.		Функция возвращает список всех настраиваемых тегов, назначенных указанным отслеживаемым объектам. Автоматически применяемые теги и импортированные теги не включаются.
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
	\|-		\|-
Строка 27:		Строка 27:
	Вы должны установить один из этих критериев:		Вы должны установить один из этих критериев:
	*Тип объекта:<code>type("TYPE")</code>		*Тип объекта:<code>type("TYPE")</code>
	*Идентификатор объекта ~~Ключ-АСТРОМ~~: <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>оператор используется, если не указано иное.
	*Тег: <code>tag("value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Любые двоеточия ( <code>:</code>), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( <code>\</code>), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.		*Тег: <code>tag("value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Любые двоеточия ( <code>:</code>), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( <code>\</code>), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.
Строка 46:		Строка 46:
	*Отношения: <code>fromRelationships.<relationshipName>()</code>и <code>toRelationships.<relationshipName>()</code>. Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа сущности GET и проверьте поля fromRelationships и toRelationships .		*Отношения: <code>fromRelationships.<relationshipName>()</code>и <code>toRelationships.<relationshipName>()</code>. Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа сущности GET и проверьте поля fromRelationships и toRelationships .
	*Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .		*Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .
	Дополнительные сведения см. в разделе Селектор объектов в документации ~~Ключ-АСТРОМ~~.		Дополнительные сведения см. в разделе Селектор объектов в документации АппОптима.

	Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.		Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.
Строка 146:		Строка 146:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"totalCount": 2,		"totalCount": 2,
	"tags": [		"tags": [
Строка 168:		Строка 168:
	Поскольку полный результат довольно длинный, он усечен до трех записей.		Поскольку полный результат довольно длинный, он усечен до трех записей.
	====Curl====		====Curl====
	<~~code>~~curl -L -X GET '<nowiki>https://mySampleEnv.live.~~astromkey~~.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.~~astromkey~~.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)</nowiki></code>		<code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/tags?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"totalCount": 31,		"totalCount": 31,
	"tags": [		"tags": [

ENetrebin в 17:22, 5 июня 2024

2024-06-05T17:22:14Z

← Предыдущая версия		Версия от 17:22, 5 июня 2024
Строка 9:		Строка 9:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
	\|-		\|-
	\|Среда ~~Активный Шлюз~~		\|Среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
	\|}		\|}

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-05T17:21:28Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

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

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9F.D0.BE.D0.BB.D1.8C.D0.B7.D0.BE.D0.B2.D0.B0.D1.82.D0.B5.D0.BB.D1.8C.D1.81.D0.BA.D0.B8.D0.B5_.D1.82.D0.B5.D0.B3.D0.B8 Пользовательские теги] / GET теги'''''

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/tags</nowiki></code>
|-
|Среда Активный Шлюз
|<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.astromkey.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.astromkey.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