GET список объектов - История изменений

IKuznetsov в 16:14, 2 января 2025

2025-01-02T16:14:49Z

← Предыдущая версия		Версия от 16:14, 2 января 2025
Строка 1:		Строка 1:
			'''''[[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=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [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%9E%D1%82%D1%81%D0%BB%D0%B5%D0%B6%D0%B8%D0%B2%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B%20v2 Отслеживаемые объекты v2] / GET список объектов'''''

	Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойствами. При запросе сущностей <code>SERVICE_METHOD</code>типа возвращаются только следующие запросы:		Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойствами. При запросе сущностей <code>SERVICE_METHOD</code>типа возвращаются только следующие запросы:

Строка 389:		Строка 391:
	}		}
	]		]
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 402:		Строка 404:
	==== Curl ====		==== Curl ====
	<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 446:		Строка 448:
	}		}
	]		]
	}~~</code>~~		}

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

IKuznetsov в 10:15, 26 декабря 2024

2024-12-26T10:15:54Z

← Предыдущая версия		Версия от 10:15, 26 декабря 2024
Строка 13:		Строка 13:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/entities</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/entities</nowiki></code>
	\|-		\|-
Строка 56:		Строка 56:

	* Тип объекта:<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>оператор используется, если не указано иное.
Строка 78:		Строка 78:
	* Отрицание: <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>. В ответ включаются только результаты, соответствующие всем критериям.
Строка 327:		Строка 327:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"totalCount": 1,		"totalCount": 1,
	"pageSize": 1,		"pageSize": 1,
Строка 394:		Строка 394:
	В этом примере в запросе перечислены службы, принадлежащие зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваивается<code>type("SERVICE"),mzId("229130632296508575249")</code> значение .		В этом примере в запросе перечислены службы, принадлежащие зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваивается<code>type("SERVICE"),mzId("229130632296508575249")</code> значение .

	Помимо идентификаторов сущностей ~~Ключ-АСТРОМ~~ по умолчанию и имен сущностей, запрос также возвращает метку времени последнего посещения службы и список типов технологий, работающих в службе. Для этого для параметра запроса полей<code>lastSeenTms,properties.serviceTechnologyTypes</code> установлено значение .		Помимо идентификаторов сущностей АппОптима по умолчанию и имен сущностей, запрос также возвращает метку времени последнего посещения службы и список типов технологий, работающих в службе. Для этого для параметра запроса полей<code>lastSeenTms,properties.serviceTechnologyTypes</code> установлено значение .

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

	==== Curl ====		==== Curl ====
	<~~code>~~curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

Строка 408:		Строка 408:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"totalCount": 52,		"totalCount": 52,
	"pageSize": 50,		"pageSize": 50,

ENetrebin: Новая страница: «Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойства...»

2022-10-14T09:14:19Z

Новая страница: «Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойства...»

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

Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойствами. При запросе сущностей <code>SERVICE_METHOD</code>типа возвращаются только следующие запросы:

* Ключевые запросы .
* Первые X запросов, которые используются для определения исходного уровня .
* Запросы, вызвавшие проблему .

Вы можете ограничить вывод, используя нумерацию страниц:

# Укажите количество результатов на странице в параметре запроса pageSize .
# Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|query
|по желанию
|-
|pageSize
|integer
|Количество объектов.

Если не установлено, используется 50.
|query
|по желанию
|-
|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.equals</code>: выполняет <code>EQUALS</code>запрос без учета регистра.
** <code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.
** <code>entityName.in</code>: позволяет указать несколько значений. Оператор <code>EQUALS</code>обращается.
** <code>caseSensitive(entityName.equals("value"))</code>: принимает любой критерий имени объекта в качестве аргументов и делает значение чувствительным к регистру.
* Состояние здоровья (HEALTHY,UNHEALTHY):<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>. В ответ включаются только результаты, соответствующие всем критериям.

Поддерживаемая длина строки составляет 2000 символов.

Поле обязательно , когда вы запрашиваете первую страницу результатов.
|query
|по желанию
|-
|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>: годы

Если не задано, используется относительный таймфрейм в три дня ( <code>now-3d</code>).
|query
|по желанию
|-
|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>: годы

Если не установлено, используется текущая метка времени.
|query
|по желанию
|-
|fields
|string
|Определяет список свойств объекта, включенных в ответ. Идентификатор и имя объекта всегда включаются в ответ.

Чтобы добавить свойства, перечислите их с начальным плюсом <code>+</code>. Вы можете указать несколько свойств, разделенных запятой (например, <code>fields=+lastSeenTms,+properties.BITNESS</code>).

Используйте запрос типа сущности GET, чтобы получить список свойств, доступных для вашего типа сущности. Поля из объекта свойств должны быть указаны в <code>properties.FIELD</code>формате (например, <code>properties.BITNESS</code>).
|query
|по желанию
|-
|sort
|string
|Определяет порядок возвращаемых объектов.

Это поле является необязательным , каждое поле имеет знаковый префикс (+/-), который соответствует порядку сортировки (+ по возрастанию и - по убыванию). Если префикс знака не установлен, будет применяться порядок сортировки по возрастанию по умолчанию.

В настоящее время заказ доступен только для отображаемого имени (например, <code>sort=name or sort =+name for ascending, sort=-name for descending</code>)
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>EntitiesList</code> ====
Список отслеживаемых объектов вместе с их свойствами.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|totalCount
|integer
|Общее количество записей в результате.
|-
|pageSize
|integer
|Количество записей на странице.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|entities
|Entity[]
|Список контролируемых объектов.
|}

==== Объект <code>Entity</code> ====
Свойства контролируемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|firstSeenTms
|integer
|Отметка времени, когда объект был впервые замечен, в миллисекундах UTC.
|-
|lastSeenTms
|integer
|Временная метка последнего появления объекта в миллисекундах UTC.
|-
|fromRelationships
|object
|Список отношений, в которых объект занимает позицию FROM.
|-
|toRelationships
|object
|Список отношений, в которых объект занимает позицию TO.
|-
|tags
|METag[]
|Набор тегов, присвоенных объекту.
|-
|managementZones
|ManagementZone[]
|Набор зон управления, к которым принадлежит объект.
|-
|entityId
|string
|Идентификатор объекта.
|-
|icon
|EntityIcon
|Значок контролируемого объекта.
|-
|properties
|object
|Список дополнительных свойств объекта.
|-
|type
|string
|Тип объекта.
|-
|displayName
|string
|Имя объекта, отображаемое в пользовательском интерфейсе.
|}

==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор объекта.
|-
|type
|string
|Тип объекта.
|}

==== Объект <code>METag</code> ====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|stringRepresentation
|string
|Строковое представление тега.
|-
|value
|string
|Значение тега.
|-
|key
|string
|Ключ тега.
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

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

==== Объект <code>ManagementZone</code> ====
Краткое представление зоны управления.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Имя зоны управления.
|-
|id
|string
|Идентификатор зоны управления.
|}

==== Объект <code>EntityIcon</code> ====
Значок контролируемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|primaryIconType
|string
|Основная иконка объекта.

Определяется идентификатором бариста значка.
|-
|customIconPath
|string
|Определяемый пользователем значок объекта.

Укажите идентификатор бариста значка или URL-адрес собственного значка.
|-
|secondaryIconType
|string
|Второстепенная иконка сущности.

Определяется идентификатором бариста значка.
|}

=== JSON-модель тела ответа ===
<code>{
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"entities": [
{
"entityId": "HOST-06F288EE2A930951",
"type": "HOST",
"displayName": "my host",
"icon": {
"primaryIconType": "linux",
"secondaryIconType": "microsoft-azure-signet",
"customIconPath": "host"
},
"firstSeenTms": 1574697667547,
"lastSeenTms": 1588242361417,
"properties": {
"bitness": 64,
"monitoringMode": "FULL_STACK",
"osType": "LINUX",
"osArchitecture": "X86",
"networkZoneId": "aws.us.east01",
"cpuCores": 8
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "architecture",
"value": "x86",
"stringRepresentation": "architecture:x86"
},
{
"context": "ENVIRONMENT",
"key": "Infrastructure",
"value": "Linux",
"stringRepresentation": "[ENVIRONMENT]Infrastructure:Linux"
}
],
"managementZones": [
{
"id": "6239538939987181652",
"name": "main app"
}
],
"fromRelationships": {
"isInstanceOf": [
{
"id": "HOST_GROUP-0E489369D663A4BF",
"type": "HOST_GROUP"
}
]
},
"toRelationships": {
"isDiskOf": [
{
"id": "DISK-0393340DCA3853B0",
"type": "DISK"
}
]
}
}
]
}</code>

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

Помимо идентификаторов сущностей Ключ-АСТРОМ по умолчанию и имен сущностей, запрос также возвращает метку времени последнего посещения службы и список типов технологий, работающих в службе. Для этого для параметра запроса полей<code>lastSeenTms,properties.serviceTechnologyTypes</code> установлено значение .

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

Результат усекается до трех записей.

==== Curl ====
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes</nowiki></code>

==== Тело ответа ====
<code>{
"totalCount": 52,
"pageSize": 50,
"nextPageKey": "AQArdHlwZSgiU0VSVklDRSIpL",
"entities": [
{
"entityId": "SERVICE-1125C375A187D27A",
"displayName": "dotNetBackend_easyTravel_x64",
"lastSeenTms": 1590609632865,
"properties": {
"serviceTechnologyTypes": [
"IIS app pool",
"ASP.NET",
"DotNet"
]
}
},
{
"entityId": "SERVICE-42C0B06C4DCFD0EF",
"displayName": "AuthenticationService",
"lastSeenTms": 1590747000977,
"properties": {
"serviceTechnologyTypes": [
"Java"
]
}
},
{
"entityId": "SERVICE-620517BB99A7ED9E",
"displayName": "BookingService",
"lastSeenTms": 1590747028702,
"properties": {
"serviceTechnologyTypes": [
"Java"
]
}
}
]
}</code>

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