GET все хосты: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Получает список всех хостов в вашей среде Ключ-АСТРОМ вместе с их параметрами. Полный сп...») |
ENetrebin (обсуждение | вклад) |
||
Строка 779: | Строка 779: | ||
{ | { | ||
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | ||
"name": " | "name": "Astromkey entity", | ||
"description": " | "description": "Astromkey entity for the REST API example" | ||
} | } | ||
], | ], |
Версия 16:58, 12 октября 2022
Получает список всех хостов в вашей среде Ключ-АСТРОМ вместе с их параметрами.
Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Вы можете дополнительно ограничить вывод с помощью нумерации страниц:
- Укажите количество результатов на странице в параметре запроса pageSize .
- Затем используйте курсор из заголовка ответа Next-Page-Key в параметре запроса nextPageKey для получения последующих страниц.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Срок ограничен максимальным периодом в 3 дня .
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
startTimestamp | integer | Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется отставание на 72 часа. |
query | по желанию |
endTimestamp | integer | Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется текущая метка времени. Срок не должен превышать 3 дней. |
query | по желанию |
relativeTime | string | Относительный период времени, начиная с настоящего времени.
Элемент может содержать эти значения
|
query | по желанию |
tag | string [] | Фильтрует результирующий набор хостов по указанному тегу. Вы можете указать несколько тегов в следующем формате: tag=tag1&tag=tag2 . Хост должен соответствовать всем указанным тегам.
В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: |
query | по желанию |
showMonitoringCandidates | boolean | Включает ( true ) или исключает ( false ) кандидата для мониторинга в ответ.
Кандидаты на мониторинг — это сетевые объекты, которые обнаруживаются, но не контролируются. |
query | по желанию |
entity | string [] | Фильтры приводят только к указанным хостам.
Для указания нескольких хостов используйте следующий формат: |
query | по желанию |
managementZone | integer | Возвращать только те хосты, которые входят в указанную зону управления. | query | по желанию |
hostGroupId | string | Фильтрует результирующий набор хостов по указанной группе хостов.
Укажите идентификаторы Ключ-АСТРОМ интересующей вас группы хостов. |
query | по желанию |
hostGroupName | string | Фильтрует результирующий набор хостов по указанной группе хостов.
Укажите название интересующей вас группы хостов. |
query | по желанию |
includeDetails | boolean | Включает ( true ) или исключает ( false ) детали, которые запрашиваются у связанных объектов.
Исключение сведений может ускорить запросы. Если не установлено, то |
query | по желанию |
pageSize | integer | Количество хостов на страницу результатов.
Если не задано, нумерация страниц не используется, и результат содержит все хосты, соответствующие заданным критериям фильтрации. |
query | по желанию |
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа.
Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора. Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы. |
query | по желанию |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Host[] | Успех |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект ResponseBody
Объект не предоставляет никаких параметров.
Объект Host
Информация о хосте.
Элемент | Тип | Описание |
---|---|---|
entityId | string | Идентификатор объекта Ключ-АСТРОМ требуемого объекта. |
displayName | string | Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе. |
customizedName | string | Пользовательское имя объекта |
discoveredName | string | Обнаруженное имя объекта |
firstSeenTimestamp | integer | Отметка времени первого обнаружения объекта в миллисекундах UTC. |
lastSeenTimestamp | integer | Отметка времени последнего обнаружения объекта в миллисекундах UTC. |
tags | TagInfo[] | Список тегов сущностей. |
fromRelationships | object | - |
toRelationships | object | - |
managementZones | EntityShortRepresentation[] | Зоны управления, частью которых является объект. |
localHostName | string | - |
openstackComputeNodeName | string | - |
esxiHostName | string | - |
monitoringMode | string | -
Элемент может содержать эти значения
|
paasAgentVersions | AgentVersion[] | Версии агентов PaaS, которые в настоящее время работают на объекте. |
ipAddresses | string [] | - |
boshStemcellVersion | string | Версия стволовых клеток Cloud Foundry BOSH. |
localIp | string | - |
cloudType | string | -
Элемент может содержать эти значения
|
CloudPlatformVendorVersion | string | Определяет версию поставщика облачной платформы. |
azureVmSizeLabel | string | - |
zosLpaName | string | Имя LPAR. |
zosTotalGeneralPurposeProcessors | integer | Количество назначенных процессоров для этого LPAR. |
openstackVmName | string | - |
paasType | string | -
Элемент может содержать эти значения
|
azureVmScaleSetName | string | - |
zosSystemName | string | Название системы. |
azureResourceGroupName | string | - |
networkZoneId | string | Идентификатор сетевой зоны, в которой находится объект. |
azureHostNames | string [] | - |
agentVersion | AgentVersion | Определяет версию агента, работающего в данный момент на объекте. |
paasMemoryLimit | integer | - |
vmwareName | string | - |
consumedHostUnits | string | - |
autoInjection | string | Статус автоинъекции
Элемент может содержать эти значения
|
hostGroup | HostGroup | - |
zosTotalZiipProcessors | integer | Количество назначенных процессоров поддержки для этого LPAR. |
boshAvailabilityZone | string | Зона доступности Cloud Foundry BOSH. |
beanstalkEnvironmentName | string | - |
publicHostName | string | - |
gceInstanceName | string | Имя экземпляра Google Compute Engine. |
awsInstanceId | string | - |
gceProjectId | string | Числовой идентификатор проекта Google Compute Engine. |
ScaleSetName | string | - |
openstackProjectName | string | - |
azureSiteNames | string [] | - |
zosCPUSerialNumber | string | Серийный номер процессора. |
boshName | string | Название Cloud Foundry BOSH. |
zosVirtualization | string | Тип виртуализации на мейнфрейме. |
boshDeploymentId | string | Идентификатор развертывания Cloud Foundry BOSH. |
gcpZone | string | Зона облачной платформы Google. |
kubernetesNode | string | Узел kubernetes, в котором находится сущность. |
cpuCores | integer | - |
azureComputeModeName | string | -
Элемент может содержать эти значения
|
awsNameTag | string | Название унаследовано от AWS. |
azureVmName | string | - |
awsInstanceType | string | - |
boshInstanceId | string | Идентификатор экземпляра Cloud Foundry BOSH. |
hypervisorType | string | -
Элемент может содержать эти значения
|
simultaneousMultithreading | integer | Количество одновременных потоков экземпляра AIX. |
gcePublicIpAddresses | string [] | Общедоступные IP-адреса Google Compute Engine. |
logicalCpuCores | integer | - |
boshInstanceName | string | Имя экземпляра Cloud Foundry BOSH. |
azureSku | string | -
Элемент может содержать эти значения
|
azureEnvironment | string | - |
azureZone | string | - |
kubernetesCluster | string | Кластер kubernetes, в котором находится сущность. |
logicalCpus | integer | Количество логических процессоров экземпляра AIX. |
gceMachineType | string | Тип машины Google Compute Engine. |
openStackInstaceType | string | - |
bitness | string | -
Элемент может содержать эти значения
|
gceProject | string | Проект Google Compute Engine. |
kubernetesLabels | object | Метки kubernetes, определенные для сущности. |
autoScalingGroup | string | - |
gceInstanceId | string | Идентификатор экземпляра Google Compute Engine. |
osVersion | string | - |
amiId | string | - |
isMonitoringCandidate | boolean | - |
oneAgentCustomHostName | string | Пользовательское имя, указанное в конфигурации ЕдиногоАгента |
userLevel | string | -
Элемент может содержать эти значения
|
virtualCpus | integer | Количество виртуальных процессоров экземпляра AIX. |
softwareTechnologies | Информация о технологии [] | - |
awsSecurityGroup | string [] | - |
azureResourceId | string | - |
osType | string | -
Элемент может содержать эти значения
|
openstackSecurityGroups | string [] | - |
osArchitecture | string | -
Элемент может содержать эти значения
|
publicIp | string | - |
zosTotalPhysicalMemory | integer | Память, назначенная хосту (Терабайт). |
zosCPUModelNumber | string | Номер модели процессора. |
openstackAvZone | string | - |
Объект TagInfo
Тег сущности Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
value | string | Значение тега.
Не применимо к пользовательским тегам. |
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта Ключ-АСТРОМ. |
name | string | Имя объекта Ключ-АСТРОМ. |
description | string | Краткое описание сущности Ключ-АСТРОМ. |
Объект AgentVersion
Определяет версию агента, работающего в данный момент на объекте.
Элемент | Тип | Описание |
---|---|---|
major | integer | Номер основной версии. |
minor | integer | Младший номер версии. |
revision | integer | Номер ревизии. |
timestamp | string | Строка временной метки: формат "ггггммдд-ччммсс |
sourceRevision | string | Строковое представление номера версии SVN. |
Объект HostGroup
Элемент | Тип | Описание |
---|---|---|
meId | string | Идентификатор объекта Ключ-АСТРОМ группы хостов. |
name | string | Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе. |
Объект _ TechnologyInfo
Элемент | Тип | Описание |
---|---|---|
type | string | - |
edition | string | - |
version | string | - |
JSON-модель тела ответа
[
{
"entityId": "string",
"displayName": "string",
"customizedName": "string",
"discoveredName": "string",
"firstSeenTimestamp": 1,
"lastSeenTimestamp": 1,
"tags": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"fromRelationships": {
"isNetworkClientOfHost": [
"string"
]
},
"toRelationships": {
"isProcessOf": [
"string"
],
"isSiteOf": [
"string"
],
"isNetworkClientOfHost": [
"string"
],
"runsOn": [
"string"
]
},
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity",
"description": "Astromkey entity for the REST API example"
}
],
"localHostName": "string",
"openstackComputeNodeName": "string",
"esxiHostName": "string",
"monitoringMode": "FULL_STACK",
"paasAgentVersions": [
{
"major": 1,
"minor": 1,
"revision": 1,
"timestamp": "string",
"sourceRevision": "string"
}
],
"ipAddresses": [
"string"
],
"boshStemcellVersion": "string",
"localIp": "string",
"cloudType": "AZURE",
"cloudPlatformVendorVersion": "string",
"azureVmSizeLabel": "string",
"zosLpaName": "string",
"zosTotalGeneralPurposeProcessors": 1,
"openstackVmName": "string",
"paasType": "AWS_ECS_EC2",
"azureVmScaleSetName": "string",
"zosSystemName": "string",
"azureResourceGroupName": "string",
"networkZoneId": "string",
"azureHostNames": [
"string"
],
"agentVersion": {},
"paasMemoryLimit": 1,
"vmwareName": "string",
"consumedHostUnits": "string",
"autoInjection": "DISABLED_MANUALLY",
"hostGroup": {
"meId": "string",
"name": "string"
},
"zosTotalZiipProcessors": 1,
"boshAvailabilityZone": "string",
"beanstalkEnvironmentName": "string",
"publicHostName": "string",
"gceInstanceName": "string",
"awsInstanceId": "string",
"gceProjectId": "string",
"scaleSetName": "string",
"openstackProjectName": "string",
"azureSiteNames": [
"string"
],
"zosCPUSerialNumber": "string",
"boshName": "string",
"zosVirtualization": "string",
"boshDeploymentId": "string",
"gcpZone": "string",
"kubernetesNode": "string",
"cpuCores": 1,
"azureComputeModeName": "DEDICATED",
"awsNameTag": "string",
"azureVmName": "string",
"awsInstanceType": "string",
"boshInstanceId": "string",
"hypervisorType": "AHV",
"simultaneousMultithreading": 1,
"gcePublicIpAddresses": [
"string"
],
"logicalCpuCores": 1,
"boshInstanceName": "string",
"azureSku": "BASIC",
"azureEnvironment": "string",
"azureZone": "string",
"kubernetesCluster": "string",
"logicalCpus": 1,
"gceMachineType": "string",
"openStackInstaceType": "string",
"bitness": "32bit",
"gceProject": "string",
"kubernetesLabels": {},
"autoScalingGroup": "string",
"gceInstanceId": "string",
"osVersion": "string",
"amiId": "string",
"isMonitoringCandidate": true,
"oneAgentCustomHostName": "string",
"userLevel": "NON_SUPERUSER",
"virtualCpus": 1,
"softwareTechnologies": [
{
"type": "string",
"edition": "string",
"version": "string"
}
],
"awsSecurityGroup": [
"string"
],
"azureResourceId": "string",
"osType": "AIX",
"openstackSecurityGroups": [
"string"
],
"osArchitecture": "ARM",
"publicIp": "string",
"zosTotalPhysicalMemory": 1,
"zosCPUModelNumber": "string",
"openstackAvZone": "string"
}
]
Заголовки ответа
Заголовок | Тип | Описание |
---|---|---|
Total-Count | integer | Предполагаемое количество результатов. |
Next-Page-Key | string | Курсор для следующей страницы результатов. Без него вы снова получите первую страницу. |
Page-Size | string | Максимальное количество результатов на странице. |
Пример
В этом примере в запросе перечислены все хосты в среде.
Маркер API передается в заголовке авторизации .
Результат усекается до двух записей.
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts
Тело ответа
[
{
"entityId": "HOST-B7A6F9EE9F366CB5",
"displayName": "tag009",
"discoveredName": "tag009",
"firstSeenTimestamp": 1538473087608,
"lastSeenTimestamp": 1538641647769,
"tags": [
{
"context": "CONTEXTLESS",
"key": "loadtest"
},
{
"context": "CONTEXTLESS",
"key": "host tag"
}
],
"fromRelationships": {
"isNetworkClientOfHost": [
"HOST-80FF8584D8954C1D",
"HOST-A281F848361E79A1"
]
},
"toRelationships": {
"isProcessOf": [
"PROCESS_GROUP_INSTANCE-9146FB8A6A155F93"
],
"isSiteOf": [
"GEOLOC_SITE-F72DF471AE5F56F6"
],
"isNetworkClientOfHost": [
"HOST-80FF8584D8954C1D"
],
"runsOn": [
"PROCESS_GROUP-83D74C22E79B074F"
]
},
"osType": "LINUX",
"osArchitecture": "X86",
"osVersion": "Ubuntu 18.04.1",
"ipAddresses": [
"127.0.0.1",
"192.168.1.1"
],
"bitness": "64bit",
"cpuCores": 4,
"logicalCpuCores": 8,
"consumedHostUnits": 2,
"managementZones": [
{
"id": "6164525246045854296",
"name": "Zone Service E"
},
{
"id": "5678",
"name": "Infrastructure Linux"
}
]
},
{
"entityId": "HOST-2540A456786EEBCA",
"displayName": "RD40",
"discoveredName": "RD40",
"firstSeenTimestamp": 1536455342329,
"lastSeenTimestamp": 1538661752404,
"tags": [
{
"context": "CONTEXTLESS",
"key": "loadtest"
},
],
"fromRelationships": {},
"toRelationships": {
"isProcessOf": [
"PROCESS_GROUP_INSTANCE-0014EF34F2D03461",
"PROCESS_GROUP_INSTANCE-306710DC5239D390"
],
"isSiteOf": [
"GEOLOC_SITE-2D77938DBFF32A41",
"AZURE_REGION-D4D61746B479FE16"
],
"runsOn": [
"PROCESS_GROUP-1527B48A2A57385A",
"PROCESS_GROUP-25544B628ABEDFAB"
]
},
"osType": "WINDOWS",
"osArchitecture": "X86",
"osVersion": "Windows Server 2016 Datacenter",
"hypervisorType": "HYPERV",
"ipAddresses": [
"127.0.0.1"
],
"bitness": "64bit",
"cpuCores": 2,
"logicalCpuCores": 2,
"cloudType": "AZURE",
"paasType": "AZURE_WEBSITES",
"paasMemoryLimit": 3583,
"azureHostNames": [
"contosomomentshkai3q.azurewebsites.net"
],
"azureSiteNames": [
"contosomomentshkai3q"
],
"azureComputeModeName": "DEDICATED",
"azureSku": "STANDARD",
"consumedHostUnits": 0.25,
"managementZones": [
{
"id": "5130731705740636866",
"name": "Windows"
}
]
}
]
Код ответа
200