GET хост: различия между версиями

Материал из Dynatrace
(Новая страница: «Получает параметры указанного хоста. Запрос создает <code>application/json</code>полезную нагрузку....»)
 
 
Строка 24: Строка 24:
|meIdentifier
|meIdentifier
|string
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого хоста.
|Идентификатор объекта Dynatrace требуемого хоста.
|path
|path
|требуется
|требуется
Строка 53: Строка 53:
|entityId
|entityId
|string
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
|Идентификатор объекта Dynatrace требуемого объекта.
|-
|-
|displayName
|displayName
|string
|string
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
|-
|-
|customizedName
|customizedName
Строка 503: Строка 503:


==== Объект <code>TagInfo</code> ====
==== Объект <code>TagInfo</code> ====
Тег сущности Ключ-АСТРОМ.
Тег сущности Dynatrace.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 540: Строка 540:


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


Строка 595: Строка 595:
|meId
|meId
|string
|string
|Идентификатор объекта Ключ-АСТРОМ группы хостов.
|Идентификатор объекта Dynatrace группы хостов.
|-
|-
|name
|name
|string
|string
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
|}
|}


Строка 658: Строка 658:
     {
     {
       "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
       "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
       "name": "Astromkey entity",
       "name": "Dynatrace entity",
       "description": "Astromkey entity for the REST API example"
       "description": "Dynatrace entity for the REST API example"
     }
     }
   ],
   ],
Строка 781: Строка 781:
==== Curl ====
==== Curl ====
  <code>curl -X GET \
  <code>curl -X GET \
   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki> \
   <nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>


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


==== Тело ответа ====
==== Тело ответа ====

Текущая версия на 16:15, 2 февраля 2023

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

Запрос создает application/jsonполезную нагрузку.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{meIdentifier}

Аутентификация

Чтобы выполstring этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
meIdentifier string Идентификатор объекта Dynatrace требуемого хоста. path требуется

Ответ

Коды ответов

Код Тип Описание
200 Host Успех

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

Объект Host

Информация о хозяине.

Элемент Тип Описание
entityId string Идентификатор объекта Dynatrace требуемого объекта.
displayName string Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
customizedName string Пользовательское имя объекта
discoveredName string Обнаруженное имя объекта
firstSeenTimestamp integer Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp integer Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags TagInfo[] Список тегов сущностей.
fromRelationships объект -
toRelationships объект -
managementZones EntityShortRepresentation[] Зоны управления, частью которых является объект.
localHostName string -
openstackComputeNodeName string -
esxiHostName string -
monitoringMode string -

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

  • FULL_STACK
  • INFRASTRUCTURE
  • OFF
paasAgentVersions AgentVersion[] Версии агентов PaaS, которые в настоящее время работают на объекте.
ipAddresses string [] -
boshStemcellVersion string Версия стволовых клеток Cloud Foundry BOSH.
localIp string -
cloudType string -

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

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

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

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

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

  • DISABLED_MANUALLY
  • DISABLED_ON_INSTALLATION
  • DISABLED_ON_SANITY_CHECK
  • ENABLED
  • FAILED_ON_INSTALLATION
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 -

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

  • DEDICATED
  • SHARED
awsNameTag string Название унаследовано от AWS.
azureVmName string -
awsInstanceType string -
boshInstanceId string Идентификатор экземпляра Cloud Foundry BOSH.
hypervisorType string -

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

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

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

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

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

  • 32bit
  • 64bit
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 -

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

  • NON_SUPERUSER
  • NON_SUPERUSER_STRICT
  • SUPERUSER
virtualCpus integer Количество виртуальных процессоров экземпляра AIX.
softwareTechnologies TechnologyInfo[] -
awsSecurityGroup string [] -
azureResourceId string -
osType string -

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

  • AIX
  • DARWIN
  • HPUX
  • LINUX
  • SOLARIS
  • WINDOWS
  • ZOS
openstackSecurityGroups string [] -
osType string -

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

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

Объект TagInfo

Тег сущности Dynatrace.

Элемент Тип Описание
context string Происхождение тега, например AWS или Cloud Foundry.

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

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

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
key string Ключ тега.

Пользовательские теги имеют значение тега здесь.

value string Значение тега.

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

Объект EntityShortRepresentation

Краткое представление объекта Dynatrace.

Элемент Тип Описание
id string Идентификатор объекта Dynatrace.
name string Имя объекта Dynatrace.
description string Краткое описание сущности Dynatrace.

Объект AgentVersion

Определяет версию агента, работающего в данный момент на объекте.

Элемент Тип Описание
major integer Номер основной версии.
minor integer Младший номер версии.
revision integer Номер ревизии.
timestamp string Строка временной метки: формат "ггггммдд-ччммсс
sourceRevision string Строковое представление номера версии SVN.

Объект _ HostGroup

Элемент Тип Описание
meId string Идентификатор объекта Dynatrace группы хостов.
name string Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.

Объект 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": "Dynatrace entity",
      "description": "Dynatrace 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"
}

Пример

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

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

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-B7A6F9EE9F366CB5

Тело ответа

{
  "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"
    }
  ]
}

Код ответа

200

Источник — https://doc.expert-apm.kz/index.php?title=GET_хост&oldid=2960