GET объект
Материал из Документация Ключ-АСТРОМ
Версия от 09:34, 14 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает полный список свойств указанной объекта. Фактический список зависит от типа об...»)
Получает полный список свойств указанной объекта. Фактический список зависит от типа объекта.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/entities/{entityId}
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entities/{entityId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение объектов ( entities.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимый |
|---|---|---|---|---|
| entityId | string | Идентификатор требуемой объекта. | дорожка | требуется |
| from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не задано, используется относительный таймфрейм в три дня ( |
запрос | по желанию |
| to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | по желанию |
| fields | string | Определяет список свойств объекта, включенных в ответ. Идентификатор и имя объекта всегда включаются в ответ.
Чтобы добавить свойства, перечислите их с начальным плюсом Используйте запрос типа объекта GET, чтобы получить список свойств, доступных для вашего типа объекта. Поля из объекта свойств должны быть указаны в |
запрос | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Entity | Успех |
Объекты тела ответа
Объект Entity
Свойства контролируемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| firstSeenTms | integer | Отметка времени, когда объект был впервые замечен, в миллисекундах UTC. |
| lastSeenTms | integer | Временная метка последнего появления объекта в миллисекундах UTC. |
| fromRelationships | объект | Список отношений, в которых объект занимает позицию FROM. |
| toRelationships | объект | Список отношений, в которых объект занимает позицию TO. |
| tags | METag[] | Набор тегов, присвоенных объекту. |
| managementZones | ManagementZone[] | Набор зон управления, к которым принадлежит объект. |
| entityId | string | Идентификатор объекта. |
| icon | EntityIcon | Значок контролируемого объекта. |
| properties | объект | Список дополнительных свойств объекта. |
| 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-модель тела ответа
{
"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"
}
]
}
}
Пример
В этом примере в запросе перечислены свойства службы dotNetBackend_easyTravel_x64 с идентификатором SERVICE-1125C375A187D27A .
Маркер API передается в заголовке авторизации .
Curl
curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A
Тело запроса
{
"entityId": "SERVICE-1125C375A187D27A",
"displayName": "dotNetBackend_easyTravel_x64",
"firstSeenTms": 1424310498896,
"lastSeenTms": 1590609632865,
"properties": {
"serviceType": "WEB_REQUEST_SERVICE",
"internalName": "dotNetBackend_easyTravel_x64",
"webServerName": "dotNetBackend_easyTravel_x64",
"softwareTechnologies": [
{
"edition": "FullCLR",
"version": "2.0.50727"
},
{
"type": "DOTNET",
"edition": ".NET Framework",
"version": "3.5.1.0"
},
{
"type": "ADO_NET",
"edition": "System.Data",
"version": "2.0.50727.8751"
},
{
"type": "ASP_DOTNET",
"version": "3.5.1.0"
},
{
"type": "IIS_APP_POOL",
"version": "10.0.14393.0"
},
{
"type": "DOTNET_REMOTING",
"version": "2.0.50727.8771"
}
],
"serviceTechnologyTypes": [
"IIS app pool",
"ASP.NET",
"DotNet"
],
"mainServiceSoftwareTech": {
"type": "ASP_DOTNET"
},
"contextRoot": "/",
"agentTechnologyType": "DOTNET"
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "customService",
"stringRepresentation": "customService"
},
{
"context": "CONTEXTLESS",
"key": "easytravel",
"value": "backend",
"stringRepresentation": "easytravel:backend"
}
],
"mangementZones": [
{
"id": "2827032493241090264",
"name": "allServices"
},
{
"id": "9130632296508575249",
"name": "Easytravel"
}
],
"fromRelationships": {
"calls": [
{
"id": "SERVICE-775060208AAA1058",
"type": "SERVICE"
},
{
"id": "SERVICE-6737CDED8F9BF969",
"type": "SERVICE"
}
],
"runsOn": [
{
"id": "PROCESS_GROUP-0A9A52EA262BC039",
"type": "PROCESS_GROUP"
}
],
"runsOnHost": [
{
"id": "HOST-B64B6B9CB11E2244",
"type": "HOST"
},
{
"id": "HOST-CF61BC45E6282234",
"type": "HOST"
}
],
"runsOnProcessGroupInstance": [
{
"id": "PROCESS_GROUP_INSTANCE-DE765F657721AF59",
"type": "PROCESS_GROUP_INSTANCE"
}
]
},
"toRelationships": {
"calls": [
{
"id": "SERVICE-D20E300A0A6814EF",
"type": "SERVICE"
},
{
"id": "SERVICE-7675DAA7464128F8",
"type": "SERVICE"
}
]
}
}
Код ответа
200
