Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде.
Кроме того, для каждого типа сущности перечислены возможные свойства сущности этого типа. Обратите внимание, что это заполнители, показывающие, какие свойства может иметь объект, а не фактические свойства. Чтобы просмотреть фактические свойства сущности, используйте запрос GET сущности .
Вы можете ограничить вывод, используя нумерацию страниц:
- Укажите количество результатов на странице в параметре запроса pageSize .
- Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/entityTypes
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entityTypes
|
Аутентификация
Чтобы выполstring этот запрос, вам нужен токен доступа с областью действия Чтение объектов ( entities.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
query | по желанию |
| pageSize | integer | Количество типов сущностей в полезной нагрузке одного ответа.
Максимально допустимый размер страницы – 500. Если не установлено, используется 50. |
query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | EntityTypeList | Успех |
| 400 | Не удалось. Больше нет типов сущностей для экспорта. |
Объекты тела ответа
Объект EntityTypeList
Список свойств всех доступных типов сущностей.
| Элемент | Тип | Описание |
|---|---|---|
| totalCount | integer | Общее количество записей в результате. |
| pageSize | integer | Количество записей на странице. |
| nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение nullна последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
| types | EntityType[] | Список метаинформации для всех доступных типов объектов |
Объект EntityType
Список свойств отслеживаемого типа объекта.
| Элемент | Тип | Описание |
|---|---|---|
| entityLimitExceeded | boolean | Был ли превышен предел создания объекта для данного типа |
| fromRelationships | ToPosition[] | Список возможных взаимосвязей, в которых отслеживаемый тип объекта занимает позицию FROM. |
| toRelationships | FromPosition[] | Список возможных взаимосвязей, в которых отслеживаемый тип объекта занимает позицию TO. |
| tags | string | Заполнитель для списка тегов фактического объекта. |
| managementZones | string | Заполнитель для списка зон управления фактического объекта. |
| dimensionKey | string | Ключ измерения, используемый в метриках для этого отслеживаемого объекта. |
| properties | EntityTypePropertyDto[] | Список дополнительных свойств отслеживаемого типа объекта. |
| type | string | Тип отслеживаемого объекта. |
| displayName | string | Отображаемое имя отслеживаемого объекта. |
Объект ToPosition
Позиция TO отношения.
| Элемент | Тип | Описание |
|---|---|---|
| toTypes | string [] | Список отслеживаемых типов объектов, которые могут занимать позицию TO. |
| id | string | Идентификатор отношения. |
Объект FromPosition
Позиция FROM отношения.
| Элемент | Тип | Описание |
|---|---|---|
| fromTypes | string [] | Список отслеживаемых типов объектов, которые могут занимать позицию FROM. |
| id | string | Идентификатор отношения. |
Объект EntityTypePropertyDto
Свойство контролируемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор свойства. |
| type | string | Тип свойства. |
| displayName | string | Отображаемое имя свойства. |
JSON-модель тела ответа
{
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"types": [
{
"type": "HOST",
"entityLimitExceeded": "false",
"properties": [
{
"id": "BITNESS",
"type": "Enum"
},
{
"id": "CPU_CORES",
"type": "Number"
}
],
"tags": "placeholder for tags",
"managementZones": "placeholder for management zones",
"fromRelationships": [
{
"id": "RUNS_ON_RESOURCE",
"toTypes": [
"CUSTOM_DEVICE"
]
},
{
"id": "IS_NETWORK_CLIENT_OF_HOST",
"toTypes": [
"HOST",
"CUSTOM_DEVICE"
]
}
],
"toRelationships": [
{
"id": "IS_DISK_OF",
"fromTypes": [
"DISK"
]
},
{
"id": "IS_SITE_OF",
"fromTypes": [
"VMWARE_DATACENTER",
"GEOLOC_SITE"
]
}
]
}
]
}
Пример
В этом примере в запросе перечислены все типы объектов, наблюдаемые в среде mySampleEnv .
Маркер API передается в заголовке авторизации .
Поскольку полный результат довольно длинный, он усечен до трех записей. Впоследствии массив свойств каждого объекта также усекается до трех записей.
Curl
curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/entityTypes' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v2/entityTypes
Тело ответа
{
"totalCount": 33,
"pageSize": 33,
"types": [
{
"type": "APPLICATION",
"properties": [
{
"id": "applicationType",
"type": "Enum"
},
{
"id": "conditionalName",
"type": "String"
},
{
"id": "customizedName",
"type": "String"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "calls",
"toTypes": [
"SERVICE"
]
}
],
"toRelationships": []
},
{
"type": "HOST",
"properties": [
{
"id": "ipAddresses",
"type": "List"
},
{
"id": "osType",
"type": "Enum"
},
{
"id": "osVersion",
"type": "String"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "runsOn",
"toTypes": [
"EC2_INSTANCE",
"VIRTUALMACHINE",
"AZURE_VM",
"OPENSTACK_VM",
"GOOGLE_COMPUTE_ENGINE",
"HYPERVISOR"
]
},
{
"id": "runsOnResource",
"toTypes": [
"CUSTOM_DEVICE"
]
},
{
"id": "isInstanceOf",
"toTypes": [
"HOST_GROUP"
]
},
{
"id": "isNetworkClientOfHost",
"toTypes": [
"HOST",
"CUSTOM_DEVICE"
]
},
{
"id": "candidateTalksWith",
"toTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
}
],
"toRelationships": [
{
"id": "isProcessOf",
"fromTypes": [
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "runsOn",
"fromTypes": [
"OPENSTACK_VM",
"PROCESS_GROUP"
]
},
{
"id": "isSiteOf",
"fromTypes": [
"GEOLOC_SITE",
"VMWARE_DATACENTER"
]
},
{
"id": "talksWithCandidate",
"fromTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "isNetworkClientOfHost",
"fromTypes": [
"CUSTOM_DEVICE",
"HOST"
]
},
{
"id": "isDiskOf",
"fromTypes": [
"DISK"
]
},
{
"id": "runsOnHost",
"fromTypes": [
"SERVICE"
]
},
{
"id": "isContainerGroupInstanceOfHost",
"fromTypes": [
"CONTAINER_GROUP_INSTANCE"
]
}
]
},
{
"type": "SERVICE",
"properties": [
{
"id": "mainServiceSoftwareTech",
"type": "Map"
},
{
"id": "port",
"type": "Number"
},
{
"id": "serviceType",
"type": "Enum"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "runsOn",
"toTypes": [
"CUSTOM_DEVICE_GROUP",
"PROCESS_GROUP"
]
},
{
"id": "runsOnProcessGroupInstance",
"toTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "runsOnHost",
"toTypes": [
"CUSTOM_DEVICE",
"HOST"
]
},
{
"id": "calls",
"toTypes": [
"SERVICE"
]
}
],
"toRelationships": [
{
"id": "calls",
"fromTypes": [
"MOBILE_APPLICATION",
"CUSTOM_APPLICATION",
"HTTP_CHECK",
"APPLICATION",
"SERVICE"
]
}
]
}
]
}
Код ответа
200