ENetrebin: Новая страница: «Получает параметры указанного хоста. Запрос создает `application/json`полезную нагрузку....»

2022-10-12T16:56:57Z

Новая страница: «Получает параметры указанного хоста. Запрос создает <code>application/json</code>полезную нагрузку....»

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

Получает параметры указанного хоста.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|meIdentifier
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого хоста.
|path
|требуется
|}

== Ответ ==

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

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

==== Объект <code>Host</code> ====
Информация о хозяине.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
|-
|displayName
|string
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|-
|customizedName
|string
|Пользовательское имя объекта
|-
|discoveredName
|string
|Обнаруженное имя объекта
|-
|firstSeenTimestamp
|integer
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|-
|lastSeenTimestamp
|integer
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|-
|tags
|TagInfo[]
|Список тегов сущностей.
|-
|fromRelationships
|объект
| -
|-
|toRelationships
|объект
| -
|-
|managementZones
|EntityShortRepresentation[]
|Зоны управления, частью которых является объект.
|-
|localHostName
|string
| -
|-
|openstackComputeNodeName
|string
| -
|-
|esxiHostName
|string
| -
|-
|monitoringMode
|string
| -
Элемент может содержать эти значения

* <code>FULL_STACK</code>
* <code>INFRASTRUCTURE</code>
* <code>OFF</code>
|-
|paasAgentVersions
|AgentVersion[]
|Версии агентов PaaS, которые в настоящее время работают на объекте.
|-
|ipAddresses
|string []
| -
|-
|boshStemcellVersion
|string
|Версия стволовых клеток Cloud Foundry BOSH.
|-
|localIp
|string
| -
|-
|cloudType
|string
| -
Элемент может содержать эти значения

* <code>AZURE</code>
* <code>EC2</code>
* <code>GOOGLE_CLOUD_PLATFORM</code>
* <code>OPENSTACK</code>
* <code>ORACLE</code>
* <code>UNRECOGNIZED</code>
|-
|CloudPlatformVendorVersion
|string
|Определяет версию поставщика облачной платформы.
|-
|azureVmSizeLabel
|string
| -
|-
|zosLpaName
|string
|Имя LPAR.
|-
|zosTotalGeneralPurposeProcessors
|integer
|Количество назначенных процессоров для этого LPAR.
|-
|openstackVmName
|string
| -
|-
|paasType
|string
| -
Элемент может содержать эти значения

* <code>AWS_ECS_EC2</code>
* <code>AWS_ECS_FARGATE</code>
* <code>AWS_LAMBDA</code>
* <code>AZURE_FUNCTIONS</code>
* <code>AZURE_WEBSITES</code>
* <code>CLOUD_FOUNDRY</code>
* <code>GOOGLE_APP_ENGINE</code>
* <code>HEROKU</code>
* <code>KUBERNETES</code>
* <code>OPENSHIFT</code>
|-
|azureVmScaleSetName
|string
| -
|-
|zosSystemName
|string
|Название системы.
|-
|azureResourceGroupName
|string
| -
|-
|networkZoneId
|string
|Идентификатор сетевой зоны, в которой находится объект.
|-
|azureHostNames
|string []
| -
|-
|agentVersion
|AgentVersion
|Определяет версию агента, работающего в данный момент на объекте.
|-
|paasMemoryLimit
|integer
| -
|-
|vmwareName
|string
| -
|-
|consumedHostUnits
|string
| -
|-
|autoInjection
|string
|Статус автоинъекции

Элемент может содержать эти значения

* <code>DISABLED_MANUALLY</code>
* <code>DISABLED_ON_INSTALLATION</code>
* <code>DISABLED_ON_SANITY_CHECK</code>
* <code>ENABLED</code>
* <code>FAILED_ON_INSTALLATION</code>
|-
|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
| -
Элемент может содержать эти значения

* <code>DEDICATED</code>
* <code>SHARED</code>
|-
|awsNameTag
|string
|Название унаследовано от AWS.
|-
|azureVmName
|string
| -
|-
|awsInstanceType
|string
| -
|-
|boshInstanceId
|string
|Идентификатор экземпляра Cloud Foundry BOSH.
|-
|hypervisorType
|string
| -
Элемент может содержать эти значения

* <code>AHV</code>
* <code>HYPERV</code>
* <code>KVM</code>
* <code>LPAR</code>
* <code>QEMU</code>
* <code>UNRECOGNIZED</code>
* <code>VIRTUALBOX</code>
* <code>VMWARE</code>
* <code>WPAR</code>
* <code>XEN</code>
|-
|simultaneousMultithreading
|integer
|Количество одновременных потоков экземпляра AIX.
|-
|gcePublicIpAddresses
|string []
|Общедоступные IP-адреса Google Compute Engine.
|-
|logicalCpuCores
|integer
| -
|-
|boshInstanceName
|string
|Имя экземпляра Cloud Foundry BOSH.
|-
|azureSku
|string
| -
Элемент может содержать эти значения

* <code>BASIC</code>
* <code>DYNAMIC</code>
* <code>FREE</code>
* <code>PREMIUM</code>
* <code>SHARED</code>
* <code>STANDARD</code>
|-
|azureEnvironment
|string
| -
|-
|azureZone
|string
| -
|-
|kubernetesCluster
|string
|Кластер kubernetes, в котором находится сущность.
|-
|logicalCpus
|integer
|Количество логических процессоров экземпляра AIX.
|-
|gceMachineType
|string
|Тип машины Google Compute Engine.
|-
|openStackInstaceType
|string
| -
|-
|bitness
|string
| -
Элемент может содержать эти значения

* <code>32bit</code>
* <code>64bit</code>
|-
|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
| -
Элемент может содержать эти значения

* <code>NON_SUPERUSER</code>
* <code>NON_SUPERUSER_STRICT</code>
* <code>SUPERUSER</code>
|-
|virtualCpus
|integer
|Количество виртуальных процессоров экземпляра AIX.
|-
|softwareTechnologies
|TechnologyInfo[]
| -
|-
|awsSecurityGroup
|string []
| -
|-
|azureResourceId
|string
| -
|-
|osType
|string
| -
Элемент может содержать эти значения

* <code>AIX</code>
* <code>DARWIN</code>
* <code>HPUX</code>
* <code>LINUX</code>
* <code>SOLARIS</code>
* <code>WINDOWS</code>
* <code>ZOS</code>
|-
|openstackSecurityGroups
|string []
| -
|-
|osType
|string
| -
Элемент может содержать эти значения

* <code>ARM</code>
* <code>IA64</code>
* <code>PARISC</code>
* <code>PPC</code>
* <code>PPCLE</code>
* <code>S390</code>
* <code>SPARC</code>
* <code>X86</code>
* <code>ZOS</code>
|-
|publicIp
|string
| -
|-
|zosTotalPhysicalMemory
|integer
|Память, назначенная хосту (Терабайт).
|-
|zosCPUModelNumber
|string
|Номер модели процессора.
|-
|openstackAvZone
|string
| -
|}

==== Объект <code>TagInfo</code> ====
Тег сущности Ключ-АСТРОМ.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

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

Элемент может содержать эти значения

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|key
|string
|Ключ тега.

Пользовательские теги имеют значение тега здесь.
|-
|value
|string
|Значение тега.

Не применимо к пользовательским тегам.
|}

==== Объект <code>EntityShortRepresentation</code> ====
Краткое представление объекта Ключ-АСТРОМ.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор объекта Ключ-АСТРОМ.
|-
|name
|string
|Имя объекта Ключ-АСТРОМ.
|-
|description
|string
|Краткое описание сущности Ключ-АСТРОМ.
|}

==== Объект <code>AgentVersion</code> ====
Определяет версию агента, работающего в данный момент на объекте.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|major
|integer
|Номер основной версии.
|-
|minor
|integer
|Младший номер версии.
|-
|revision
|integer
|Номер ревизии.
|-
|timestamp
|string
|Строка временной метки: формат "ггггммдд-ччммсс
|-
|sourceRevision
|string
|Строковое представление номера версии SVN.
|}

==== Объект _ <code>HostGroup</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|meId
|string
|Идентификатор объекта Ключ-АСТРОМ группы хостов.
|-
|name
|string
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|}

==== Объект <code>TechnologyInfo</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
| -
|-
|edition
|string
| -
|-
|version
|string
| -
|}

=== JSON-модель тела ответа ===
<code>{
"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"
}</code>

== Пример ==
В этом примере запрос запрашивает параметры узла tag009 с идентификатором HOST-B7A6F9EE9F366CB5 .

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

==== Curl ====
<code>curl -X GET \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki></code>

==== Тело ответа ====
<code>{
"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"
}
]
}</code>

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

GET хост - История изменений

ENetrebin: Новая страница: «Получает параметры указанного хоста. Запрос создает application/jsonполезную нагрузку....»

ENetrebin: Новая страница: «Получает параметры указанного хоста. Запрос создает `application/json`полезную нагрузку....»