Список объектов, наблюдаемых в течение указанного периода времени, вместе с их свойствами. При запросе сущностей SERVICE_METHODтипа возвращаются только следующие запросы:
- Ключевые запросы .
- Первые X запросов, которые используются для определения исходного уровня .
- Запросы, вызвавшие проблему .
Вы можете ограничить вывод, используя нумерацию страниц:
- Укажите количество результатов на странице в параметре запроса pageSize .
- Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/entities
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entities
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение объектов ( entities.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
query | по желанию |
| pageSize | integer | Количество объектов.
Если не установлено, используется 50. |
query | по желанию |
| entitySelector | string | Определяет область запроса. В ответ включаются только объекты, соответствующие указанным критериям.
Вы должны установить один из этих критериев:
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ. Чтобы задать несколько критериев, разделите их запятой ( Поддерживаемая длина строки составляет 2000 символов. Поле обязательно , когда вы запрашиваете первую страницу результатов. |
query | по желанию |
| from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не задано, используется относительный таймфрейм в три дня ( |
query | по желанию |
| to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
| fields | string | Определяет список свойств объекта, включенных в ответ. Идентификатор и имя объекта всегда включаются в ответ.
Чтобы добавить свойства, перечислите их с начальным плюсом Используйте запрос типа сущности GET, чтобы получить список свойств, доступных для вашего типа сущности. Поля из объекта свойств должны быть указаны в |
query | по желанию |
| sort | string | Определяет порядок возвращаемых объектов.
Это поле является необязательным , каждое поле имеет знаковый префикс (+/-), который соответствует порядку сортировки (+ по возрастанию и - по убыванию). Если префикс знака не установлен, будет применяться порядок сортировки по возрастанию по умолчанию. В настоящее время заказ доступен только для отображаемого имени (например, |
query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | EntitiesList | Успех |
Объекты тела ответа
Объект EntitiesList
Список отслеживаемых объектов вместе с их свойствами.
| Элемент | Тип | Описание |
|---|---|---|
| totalCount | integer | Общее количество записей в результате. |
| pageSize | integer | Количество записей на странице. |
| nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение nullна последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
| entities | Entity[] | Список контролируемых объектов. |
Объект Entity
Свойства контролируемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| 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 | Имя объекта, отображаемое в пользовательском интерфейсе. |
Объект EntityId
Краткое представление отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор объекта. |
| type | string | Тип объекта. |
Объект METag
Тег отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| stringRepresentation | string | Строковое представление тега. |
| value | string | Значение тега. |
| key | string | Ключ тега. |
| context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это |
Объект ManagementZone
Краткое представление зоны управления.
| Элемент | Тип | Описание |
|---|---|---|
| name | string | Имя зоны управления. |
| id | string | Идентификатор зоны управления. |
Объект EntityIcon
Значок контролируемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| primaryIconType | string | Основная иконка объекта.
Определяется идентификатором бариста значка. |
| customIconPath | string | Определяемый пользователем значок объекта.
Укажите идентификатор бариста значка или URL-адрес собственного значка. |
| secondaryIconType | string | Второстепенная иконка сущности.
Определяется идентификатором бариста значка. |
JSON-модель тела ответа
{
"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"
}
]
}
}
]
}
Пример
В этом примере в запросе перечислены службы, принадлежащие зонам управления с идентификатором 229130632296508575249 . Для этого параметру запроса entitySelector присваиваетсяtype("SERVICE"),mzId("229130632296508575249") значение .
Помимо идентификаторов сущностей Ключ-АСТРОМ по умолчанию и имен сущностей, запрос также возвращает метку времени последнего посещения службы и список типов технологий, работающих в службе. Для этого для параметра запроса полейlastSeenTms,properties.serviceTechnologyTypes установлено значение .
Маркер API передается в заголовке авторизации .
Результат усекается до трех записей.
Curl
curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/entities?entitySelector=type(%22SERVICE%22),mzId(%229130632296508575249%22)&fields=lastSeenTms,properties.serviceTechnologyTypes
Тело ответа
{
"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"
]
}
}
]
}
Код ответа
200