ЕдиныйАгент на хосте: различия между версиями

Версия 09:00, 11 октября 2022

ЕдиныйАгент на хосте API позволяет вам проверять конфигурацию экземпляров ЕдиныйАгент на ваших хостах.

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

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v1/oneagents`
GET	Окружающая среда ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/oneagents`

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

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

Параметры

Параметр	Тип	Описание	In	Необходимый
includeDetails	boolean	Включает ( `true`) или исключает ( `false`) детали, которые запрашиваются у связанных объектов. Исключение сведений может ускорить запросы. Если не установлено, то `true`используется.	query	по желанию
startTimestamp	integer	Метка времени начала запрошенного таймфрейма в миллисекундах (UTC). Если не задано, используется отставание на 72 часа.	query	по желанию
endTimestamp	integer	Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC). Если не задано, используется текущая метка времени. Срок не должен превышать 7 месяцев (214 дней).	query	по желанию
относительное время	string	Относительный период времени, начиная с настоящего времени. Если вам нужно указать относительный период времени, который не представлен в списке возможных значений, укажите startTimestamp (до 214 дней назад) и оставьте endTimestamp и relativeTime пустыми. Элемент может содержать эти значения `10mins` `15mins` `2hours` `30mins` `3days` `5mins` `6hours` `day` `hour` `min` `month` `week`	query	по желанию
ярлык	string []	Фильтрует результирующий набор хостов по указанному тегу. Вы можете указать несколько тегов в следующем формате: `tag=tag1&tag=tag2`. Хост должен соответствовать всем указанным тегам. В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: `tag=[context]key:value`. Для пользовательских тегов "ключ-значение" не указывайте контекст: `tag=key:value`.	query	по желанию
организация	string []	Фильтры приводят только к указанным хостам. Для указания нескольких хостов используйте следующий формат: `entity=ID1&entity=ID2`.	query	по желанию
managementZoneId	integer	Возвращать только те хосты, которые входят в указанную зону управления. Укажите здесь идентификатор зоны управления.	query	по желанию
Зона управления	string	Возвращать только те хосты, которые входят в указанную зону управления. Укажите здесь имя зоны управления. Если задан параметр managementZoneId , этот параметр игнорируется.	query	по желанию
networkZoneId	string	Фильтрует результирующий набор хостов по указанной сетевой зоне. Укажите идентификатор объекта Dynatrace требуемой сетевой зоны. Вы можете получить список доступных сетевых зон с помощью вызова GET all network zone .	query	по желанию
hostGroupId	string	Фильтрует результирующий набор хостов по указанной группе хостов. Укажите идентификатор объекта Dynatrace требуемой группы хостов.	query	по желанию
hostGroupName	string	Фильтрует результирующий набор хостов по указанной группе хостов. Укажите имя требуемой группы хостов.	query	по желанию
тип ОС	string	Фильтрует результирующий набор хостов по типу ОС. Элемент может содержать эти значения `AIX` `DARWIN` `HPUX` `LINUX` `SOLARIS` `WINDOWS` `ZOS`	query	по желанию
тип облака	string	Фильтрует результирующий набор хостов по типу облака. Элемент может содержать эти значения `AZURE` `EC2` `GOOGLE_CLOUD_PLATFORM` `OPENSTACK` `ORACLE` `UNRECOGNIZED`	query	по желанию
автоинъекция	string	Фильтрует результирующий набор хостов по статусу автоматической инъекции. Элемент может содержать эти значения `DISABLED_MANUALLY` `DISABLED_ON_INSTALLATION` `DISABLED_ON_SANITY_CHECK` `ENABLED` `FAILED_ON_INSTALLATION`	query	по желанию
состояние доступности	string	Фильтрует результирующий набор хостов по состоянию доступности OneAgent. `MONITORED`: хосты, на которых OneAgent включен и активен. `UNMONITORED`: хосты, на которых OneAgent отключен и неактивен. `CRASHED`: хосты, на которых OneAgent вернул код состояния сбоя. `LOST`: Хосты, где невозможно установить соединение с OneAgent. `PRE_MONITORED`: хосты, на которых OneAgent инициализируется для мониторинга. `SHUTDOWN`: хосты, на которых OneAgent завершает работу в контролируемом процессе. `UNEXPECTED_SHUTDOWN`: хосты, на которых OneAgent завершает работу в результате неконтролируемого процесса. `UNKNOWN`: хосты, на которых состояние OneAgent неизвестно. Элемент может содержать эти значения `CRASHED` `LOST` `MONITORED` `PRE_MONITORED` `SHUTDOWN` `UNEXPECTED_SHUTDOWN` `UNKNOWN` `UNMONITORED`	query	по желанию
подробныйAvailabilityState	string	Фильтрует результирующий набор хостов по подробному состоянию доступности OneAgent. `UNKNOWN`: хосты, на которых состояние OneAgent неизвестно. `PRE_MONITORED`: хосты, на которых OneAgent инициализируется для мониторинга. `CRASHED_UNKNOWN`: хосты, на которых произошел сбой OneAgent по неизвестной причине. `CRASHED_FAILURE`: хосты, на которых OneAgent вернул код состояния сбоя. `LOST_UNKNOWN`: Хосты, на которых невозможно установить соединение с OneAgent по неизвестной причине. `LOST_CONNECTION`: хосты, на которых OneAgent признан неактивным. `LOST_AGENT_UPGRADE_FAILED`: хосты, на которых OneAgent может иметь потенциальную проблему обновления из-за бездействия после обновления. `SHUTDOWN_UNKNOWN_UNEXPECTED`: хосты, на которых OneAgent завершает работу в результате неконтролируемого процесса. `SHUTDOWN_UNKNOWN`: хосты, на которых OneAgent отключился по неизвестной причине. `SHUTDOWN_GRACEFUL`: хосты, на которых OneAgent отключился из-за отключения хоста. `SHUTDOWN_STOPPED`: хосты, на которых OneAgent отключился из-за остановки хоста. `SHUTDOWN_AGENT_LOST`: хосты, на которых модуль PaaS признан неактивным. `SHUTDOWN_SPOT_INSTANCE`: хосты, на которых завершение работы OneAgent было вызвано прерыванием работы спотового инстанса AWS. `UNMONITORED_UNKNOWN`: хосты, на которых OneAgent отключен и неактивен по неизвестной причине. `UNMONITORED_TERMINATED`: хосты, на которых OneAgent завершил работу. `UNMONITORED_DISABLED`: хосты, на которых OneAgent отключен в конфигурации. `UNMONITORED_AGENT_STOPPED`: хосты, на которых OneAgent остановлен. `UNMONITORED_AGENT_RESTART_TRIGGERED`: хосты, на которых перезапускается OneAgent. `UNMONITORED_AGENT_UNINSTALLED`: хосты, на которых удален OneAgent. `UNMONITORED_AGENT_DISABLED`: хосты, на которых OneAgent сообщил, что он отключен. `UNMONITORED_AGENT_UPGRADE_FAILED`: Хосты, на которых у OneAgent есть потенциальная проблема с обновлением. `UNMONITORED_ID_CHANGED`: Хосты, ID которых OneAgent потенциально может изменить во время обновления. `UNMONITORED_AGENT_LOST`: хосты, на которых OneAgent признан недоступным из-за проблем со связью с сервером. `UNMONITORED_AGENT_UNREGISTERED`: хосты, на которых модуль кода был признан недоступным из-за завершения работы. `UNMONITORED_AGENT_VERSION_REJECTED`: хосты, на которых OneAgent был отклонен из-за того, что версия не соответствует минимальным требованиям к версии агента. `MONITORED`: хосты, на которых OneAgent включен и активен. `MONITORED_ENABLED`: хосты, на которых OneAgent включен в конфигурации. `MONITORED_AGENT_REGISTERED`: Хосты, на которых был распознан новый OneAgent. `MONITORED_AGENT_UPGRADE_STARTED`: хосты, на которых OneAgent был отключен из-за обновления. `MONITORED_AGENT_ENABLED`: хосты, на которых OneAgent сообщил, что он включен. `MONITORED_AGENT_VERSION_ACCEPTED`: хосты, на которых OneAgent был принят, поскольку версия соответствует минимальным требованиям к версии агента. Элемент может содержать эти значения `CRASHED_FAILURE` `CRASHED_UNKNOWN` `LOST_AGENT_UPGRADE_FAILED` `LOST_CONNECTION` `LOST_UNKNOWN` `MONITORED` `MONITORED_AGENT_ENABLED` `MONITORED_AGENT_REGISTERED` `MONITORED_AGENT_UPGRADE_STARTED` `MONITORED_AGENT_VERSION_ACCEPTED` `MONITORED_ENABLED` `PRE_MONITORED` `SHUTDOWN_AGENT_LOST` `SHUTDOWN_GRACEFUL` `SHUTDOWN_SPOT_INSTANCE` `SHUTDOWN_STOPPED` `SHUTDOWN_UNKNOWN` `SHUTDOWN_UNKNOWN_UNEXPECTED` `UNKNOWN` `UNMONITORED_AGENT_DISABLED` `UNMONITORED_AGENT_LOST` `UNMONITORED_AGENT_RESTART_TRIGGERED` `UNMONITORED_AGENT_STOPPED` `UNMONITORED_AGENT_UNINSTALLED` `UNMONITORED_AGENT_UNREGISTERED` `UNMONITORED_AGENT_UPGRADE_FAILED` `UNMONITORED_AGENT_VERSION_REJECTED` `UNMONITORED_DISABLED` `UNMONITORED_ID_CHANGED` `UNMONITORED_TERMINATED` `UNMONITORED_UNKNOWN`	query	по желанию
Тип мониторинга	string	Фильтрует результирующий набор узлов по режиму мониторинга OneAgent, развернутого на узле. Элемент может содержать эти значения `CLOUD_INFRASTRUCTURE` `FULL_STACK` `STANDALONE`	query	по желанию
агентверсионис	string	Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия OneAgent. Укажите здесь оператор сравнения. Элемент может содержать эти значения `EQUAL` `GREATER` `GREATER_EQUAL` `LOWER` `LOWER_EQUAL`	query	по желанию
номер версии агента	string	Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия OneAgent. Укажите версию в `<major>.<minor>.<revision>`формате, например `1.182.0`. Вы можете получить список доступных версий с помощью вызова доступных версий GET .	query	по желанию
autoUpdateSetting	string	Фильтрует результирующий набор узлов по фактическому состоянию параметра автоматического обновления развернутых агентов OneAgent. Элемент может содержать эти значения `ENABLED` `DISABLED`	query	по желанию
обновить состояние	string	Фильтрует результирующий набор узлов по статусу обновления OneAgent, развернутого на узле. Элемент может содержать эти значения `INCOMPATIBLE` `OUTDATED` `SCHEDULED` `SUPPRESSED` `UNKNOWN` `UP2DATE` `UPDATE_IN_PROGRESS` `UPDATE_PENDING` `UPDATE_PROBLEM`	query	по желанию
ошибочная версия	boolean	Отфильтровывает результирующий набор хостов, выбирая те, на которых работает версия OneAgent, помеченная как неисправная.	query	по желанию
ActiveGateId	string	Отфильтровывает результирующий набор хостов на те, которые в данный момент подключены к ActiveGate с указанным ID. Используйте ключевое слово DIRECT_COMMUNICATION , чтобы найти хосты, не подключенные ни к одному ActiveGate.	query	по желанию
технологияModuleType	string	Отфильтровывает результирующий набор хостов до тех, на которых работает указанный модуль кода OneAgent. Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. Элемент может содержать эти значения `APACHE` `DOT_NET` `DUMPPROC` `GO` `IBM_INTEGRATION_BUS` `IIS` `JAVA` `LOG_ANALYTICS` `NETTRACER` `NETWORK` `NGINX` `NODE_JS` `OPENTRACINGNATIVE` `PHP` `PROCESS` `PYTHON` `RUBY` `SDK` `UPDATER` `VARNISH` `Z_OS`	query	по желанию
технологияModuleVersionIs	string	Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода. Укажите здесь оператор сравнения. Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. Элемент может содержать эти значения `EQUAL` `GREATER` `GREATER_EQUAL` `LOWER` `LOWER_EQUAL`	query	по желанию
номер_версии_модуля_технологии	string	Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода. Укажите версию в `<major>.<minor>.<revision>`формате, например `1.182.0`. Вы можете получить список доступных версий с помощью вызова доступных версий GET . Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам.	query	по желанию
технологияModuleFaultyVersion	boolean	Отфильтровывает результирующий набор хостов до тех, на которых работает версия модуля кода, помеченная как неисправная. Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам.	query	по желанию
имя_плагина	string	Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным именем. Оператор CONTAINS применяется к указанному значению. Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам.	query	по желанию
pluginVersionIs	string	Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина. Укажите здесь оператор сравнения. Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам. Элемент может содержать эти значения `EQUAL` `GREATER` `GREATER_EQUAL` `LOWER` `LOWER_EQUAL`	query	по желанию
номер версии плагина	string	Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина. Укажите версию в `<major>.<minor>.<revision>`формате, например `1.182.0`. Вы можете получить список доступных версий с помощью вызова доступных версий GET . `<minor>`и `<revision>`части номера версии являются необязательными. Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам.	query	по желанию
состояние плагина	string	Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным состоянием. Элемент может содержать эти значения `DISABLED` `ERROR_AUTH` `ERROR_COMMUNICATION_FAILURE` `ERROR_CONFIG` `ERROR_TIMEOUT` `ERROR_UNKNOWN` `INCOMPATIBLE` `LIMIT_REACHED` `NOTHING_TO_REPORT` `OK` `STATE_TYPE_UNKNOWN` `UNINITIALIZED` `UNSUPPORTED` `WAITING_FOR_STATE`	query	по желанию
ключ следующей страницы	string	Курсор для следующей страницы результатов, если результаты не помещаются на одной странице. Вы можете найти значение курсора на текущей странице ответа, в поле nextPageKey . Чтобы получить последующие страницы, вы должны указать это значение курсора в своем запросе, а все остальные параметры запроса оставить такими, какими они были в исходном запросе. Если вы не укажете курсор, всегда будет возвращаться первая страница.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	Страница со списком хостов	Успех

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

Объект _ `HostsListPage`

Список хостов с информацией о развертывании OneAgent для каждого хоста.

Элемент	Тип	Описание
процент среды	количество	Ход поиска среды в процентах.
ключ следующей страницы	нить	Курсор для следующей страницы результатов. Имеет значение `null`на последней странице. Может быть другая страница результатов, даже если текущая страница пуста.
хозяева	Информация об агенте хоста []	Список хостов с информацией о развертывании OneAgent для каждого хоста.

Объект _ `HostAgentInfo`

Развертывание OneAgent на хосте.

Элемент	Тип	Описание
информация о хосте	Хозяин	Информация о хозяине.
ошибочная версия	логический	Версия OneAgent ошибочна ( `true`) или нет ( `false`).
активный	логический	OneAgent активен ( `true`) или неактивен ( `false`).
сконфигурированныйМониторингМоде	нить	Настроен режим мониторинга OneAgent. Элемент может содержать эти значения `CLOUD_INFRASTRUCTURE` `FULL_STACK`
Тип мониторинга	нить	Режим мониторинга OneAgent. Элемент может содержать эти значения `CLOUD_INFRASTRUCTURE` `FULL_STACK` `STANDALONE`
autoUpdateSetting	нить	Эффективная настройка автоматического обновления OneAgent. Для хоста с унаследованной конфигурацией он рассчитывается на основе конфигурации его родителя. Элемент может содержать эти значения `ENABLED` `DISABLED`
обновить состояние	нить	Текущий статус обновления OneAgent. Элемент может содержать эти значения `INCOMPATIBLE` `OUTDATED` `SCHEDULED` `SUPPRESSED` `UNKNOWN` `UP2DATE` `UPDATE_IN_PROGRESS` `UPDATE_PENDING` `UPDATE_PROBLEM`
доступные версии	строка []	Список версий OneAgent, до которых можно обновить.
сконфигурированныймониторингенаблед	логический	Мониторинг включен ( `true`) или отключен ( `false`) в конфигурации OneAgent.
состояние доступности	нить	Состояние доступности OneAgent. Элемент может содержать эти значения `CRASHED` `LOST` `MONITORED` `PRE_MONITORED` `SHUTDOWN` `UNEXPECTED_SHUTDOWN` `UNKNOWN` `UNMONITORED`
подробныйAvailabilityState	нить	Подробное состояние доступности OneAgent. Элемент может содержать эти значения `CRASHED_FAILURE` `CRASHED_UNKNOWN` `LOST_AGENT_UPGRADE_FAILED` `LOST_CONNECTION` `LOST_UNKNOWN` `MONITORED` `MONITORED_AGENT_ENABLED` `MONITORED_AGENT_REGISTERED` `MONITORED_AGENT_UPGRADE_STARTED` `MONITORED_AGENT_VERSION_ACCEPTED` `MONITORED_ENABLED` `PRE_MONITORED` `SHUTDOWN_AGENT_LOST` `SHUTDOWN_GRACEFUL` `SHUTDOWN_SPOT_INSTANCE` `SHUTDOWN_STOPPED` `SHUTDOWN_UNKNOWN` `SHUTDOWN_UNKNOWN_UNEXPECTED` `UNKNOWN` `UNMONITORED_AGENT_DISABLED` `UNMONITORED_AGENT_LOST` `UNMONITORED_AGENT_RESTART_TRIGGERED` `UNMONITORED_AGENT_STOPPED` `UNMONITORED_AGENT_UNINSTALLED` `UNMONITORED_AGENT_UNREGISTERED` `UNMONITORED_AGENT_UPGRADE_FAILED` `UNMONITORED_AGENT_VERSION_REJECTED` `UNMONITORED_DISABLED` `UNMONITORED_ID_CHANGED` `UNMONITORED_TERMINATED` `UNMONITORED_UNKNOWN`
~~currentActiveGateId~~	целое число	УСТАРЕЛО Это поле устарело и предназначено для обратной совместимости. Вместо этого используйте поле currentActiveGateIds .
currentActiveGateIds	строка []	Список идентификаторов ActiveGate для ActiveGate, к которым в данный момент подключен OneAgent.
currentNetworkZoneId	нить	Идентификатор сетевой зоны, которую использует OneAgent.
модули	Информация о модуле []	Список модулей кода, развернутых на хосте.
плагины	Информация о плагине []	Список плагинов, развернутых на хосте.

Объект _ `Host`

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

Элемент	Тип	Описание
идентификатор объекта	нить	Идентификатор объекта Dynatrace требуемого объекта.
показать имя	нить	Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
индивидуальное имя	нить	Пользовательское имя объекта
обнаружил имя	нить	Обнаруженное имя объекта
firstSeenTimestamp	целое число	Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp	целое число	Отметка времени последнего обнаружения объекта в миллисекундах UTC.
теги	Информация о теге []	Список тегов сущностей.
отОтношения	объект	-
кОтношения	объект	-
управлениеЗоны	Краткое представление объекта []	Зоны управления, частью которых является объект.
localHostName	нить	-
openstackComputeNodeName	нить	-
esxiHostName	нить	-
режим мониторинга	нить	- Элемент может содержать эти значения `FULL_STACK` `INFRASTRUCTURE` `OFF`
paasAgentVersions	Версия агента []	Версии агентов PaaS, которые в настоящее время работают на объекте.
IP-адреса	строка []	-
boshStemcellВерсия	нить	Версия стволовых клеток Cloud Foundry BOSH.
локальный IP	нить	-
тип облака	нить	- Элемент может содержать эти значения `AZURE` `EC2` `GOOGLE_CLOUD_PLATFORM` `OPENSTACK` `ORACLE` `UNRECOGNIZED`
CloudPlatformVendorVersion	нить	Определяет версию поставщика облачной платформы.
азуревмсизелабел	нить	-
зослпанаме	нить	Имя LPAR.
zosTotalGeneralPurposeПроцессоры	целое число	Количество назначенных процессоров для этого LPAR.
openstackVmName	нить	-
paasType	нить	- Элемент может содержать эти значения `AWS_ECS_EC2` `AWS_ECS_FARGATE` `AWS_LAMBDA` `AZURE_FUNCTIONS` `AZURE_WEBSITES` `CLOUD_FOUNDRY` `GOOGLE_APP_ENGINE` `HEROKU` `KUBERNETES` `OPENSHIFT`
азуревмскалесетнаме	нить	-
zosSystemName	нить	Название системы.
azureResourceGroupName	нить	-
networkZoneId	нить	Идентификатор сетевой зоны, в которой находится объект.
azureHostNames	строка []	-
агентВерсия	Версия агента	Определяет версию агента, работающего в данный момент на объекте.
paasMemoryLimit	целое число	-
vmwareName	нить	-
потребляемыеHostUnits	нить	-
автоинъекция	нить	Статус автоинъекции Элемент может содержать эти значения `DISABLED_MANUALLY` `DISABLED_ON_INSTALLATION` `DISABLED_ON_SANITY_CHECK` `ENABLED` `FAILED_ON_INSTALLATION`
hostGroup	Хост- группа	-
zosTotalZiipПроцессоры	целое число	Количество назначенных процессоров поддержки для этого LPAR.
boshAvailabilityZone	нить	Зона доступности Cloud Foundry BOSH.
beanstalkEnvironmentName	нить	-
общественное имя хоста	нить	-
gceInstanceName	нить	Имя экземпляра Google Compute Engine.
awsInstanceId	нить	-
gceProjectId	нить	Числовой идентификатор проекта Google Compute Engine.
ScaleSetName	нить	-
openstackProjectName	нить	-
azureSiteNames	строка []	-
zosCPUSerialNumber	нить	Серийный номер процессора.
boshName	нить	Название Cloud Foundry BOSH.
zosВиртуализация	нить	Тип виртуализации на мейнфрейме.
boshDeploymentId	нить	Идентификатор развертывания Cloud Foundry BOSH.
gcpZone	нить	Зона облачной платформы Google.
kubernetesNode	нить	Узел kubernetes, в котором находится сущность.
процессорные ядра	целое число	-
azureComputeModeName	нить	- Элемент может содержать эти значения `DEDICATED` `SHARED`
awsNameTag	нить	Название унаследовано от AWS.
azureVmName	нить	-
awsInstanceType	нить	-
boshInstanceId	нить	Идентификатор экземпляра Cloud Foundry BOSH.
тип гипервизора	нить	- Элемент может содержать эти значения `AHV` `HYPERV` `KVM` `LPAR` `QEMU` `UNRECOGNIZED` `VIRTUALBOX` `VMWARE` `WPAR` `XEN`
одновременная многопоточность	целое число	Количество одновременных потоков экземпляра AIX.
gcePublicIpAddresses	строка []	Общедоступные IP-адреса Google Compute Engine.
логические процессорные ядра	целое число	-
boshInstanceName	нить	Имя экземпляра Cloud Foundry BOSH.
лазурныйSku	нить	- Элемент может содержать эти значения `BASIC` `DYNAMIC` `FREE` `PREMIUM` `SHARED` `STANDARD`
лазурная среда	нить	-
лазурная зона	нить	-
kubernetesкластер	нить	Кластер kubernetes, в котором находится сущность.
логический ЦП	целое число	Количество логических процессоров экземпляра AIX.
gceMachineType	нить	Тип машины Google Compute Engine.
openStackInstaceType	нить	-
битность	нить	- Элемент может содержать эти значения `32bit` `64bit`
gceProject	нить	Проект Google Compute Engine.
kubernetesLabels	объект	Метки kubernetes, определенные для объекта.
autoScalingGroup	нить	-
gceInstanceId	нить	Идентификатор экземпляра Google Compute Engine.
ОСВерсия	нить	-
среди	нить	-
isMonitoringCandidate	логический	-
oneAgentCustomHostName	нить	Пользовательское имя, указанное в конфигурации OneAgent.
уровень пользователя	нить	- Элемент может содержать эти значения `NON_SUPERUSER` `NON_SUPERUSER_STRICT` `SUPERUSER`
виртуальный процессор	целое число	Количество виртуальных процессоров экземпляра AIX.
программное обеспечениеТехнологии	Информация о технологии []	-
awsSecurityGroup	строка []	-
azureResourceId	нить	-
тип ОС	нить	- Элемент может содержать эти значения `AIX` `DARWIN` `HPUX` `LINUX` `SOLARIS` `WINDOWS` `ZOS`
openstackSecurityGroups	строка []	-
ОСАрхитектура	нить	- Элемент может содержать эти значения `ARM` `IA64` `PARISC` `PPC` `PPCLE` `S390` `SPARC` `X86` `ZOS`
публичный IP	нить	-
zosTotalPhysicalMemory	целое число	Память, назначенная хосту (Терабайт).
zosCPUModelNumber	нить	Номер модели процессора.
openstackAvZone	нить	-

Объект _ `TagInfo`

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

Элемент	Тип	Описание
контекст	нить	Происхождение тега, например AWS или Cloud Foundry. Пользовательские теги используют это `CONTEXTLESS`значение. Элемент может содержать эти значения `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`
ключ	нить	Ключ тега. Пользовательские теги имеют значение тега здесь.
ценность	нить	Значение тега. Не применимо к пользовательским тегам.

Объект _ `EntityShortRepresentation`

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

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

Объект _ `AgentVersion`

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

Элемент	Тип	Описание
главный	целое число	Номер основной версии.
незначительный	целое число	Младший номер версии.
ревизия	целое число	Номер ревизии.
отметка времени	нить	Строка временной метки: формат "ггггммдд-ччммсс
Исходная версия	нить	Строковое представление номера версии SVN.

Объект _ `HostGroup`

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

Объект _ `TechnologyInfo`

Элемент	Тип	Описание
тип	нить	-
версия	нить	-
версия	нить	-

Объект _ `ModuleInfo`

Модуль кода OneAgent.

Элемент	Тип	Описание
тип модуля	нить	Тип модуля кода. Элемент может содержать эти значения `APACHE` `DOT_NET` `DUMPPROC` `GO` `IBM_INTEGRATION_BUS` `IIS` `JAVA` `LOG_ANALYTICS` `NETTRACER` `NETWORK` `NGINX` `NODE_JS` `OPENTRACINGNATIVE` `PHP` `PROCESS` `PYTHON` `RUBY` `SDK` `UPDATER` `VARNISH` `Z_OS`
экземпляры	Экземпляр модуля []	Список экземпляров модуля кода.

Объект _ `ModuleInstance`

Экземпляр модуля кода OneAgent.

Элемент	Тип	Описание
имя_экземпляра	нить	Имя экземпляра.
модульВерсия	нить	Версия модуля кода.
ошибочная версия	логический	Версия кодового модуля ошибочна ( `true`) или нет ( `false`).
активный	логический	Экземпляр модуля кода активен ( `true`) или неактивен ( `false`).

Объект _ `PluginInfo`

Плагин OneAgent.

Элемент	Тип	Описание
имя_плагина	нить	Название плагина.
экземпляры	Экземпляр плагина []	Список экземпляров плагина.

Объект _ `PluginInstance`

Экземпляр подключаемого модуля OneAgent.

Элемент	Тип	Описание
версия плагина	нить	Версия плагина.
государство	нить	Состояние экземпляра плагина.

JSON-модель тела ответа

{
  "percentageOfEnvironmentSearched": 1,
  "nextPageKey": "string",
  "hosts": [
    {
      "hostInfo": {
        "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"
      },
      "faultyVersion": true,
      "active": true,
      "configuredMonitoringMode": "CLOUD_INFRASTRUCTURE",
      "monitoringType": "CLOUD_INFRASTRUCTURE",
      "autoUpdateSetting": "ENABLED",
      "updateStatus": "INCOMPATIBLE",
      "availableVersions": [
        "string"
      ],
      "configuredMonitoringEnabled": true,
      "availabilityState": "CRASHED",
      "detailedAvailabilityState": "CRASHED_FAILURE",
      "currentActiveGateId": 1,
      "currentActiveGateIds": [
        "string"
      ],
      "currentNetworkZoneId": "string",
      "modules": [
        {
          "moduleType": "APACHE",
          "instances": [
            {
              "instanceName": "string",
              "moduleVersion": "string",
              "faultyVersion": true,
              "active": true
            }
          ]
        }
      ],
      "plugins": [
        {
          "pluginName": "string",
          "instances": [
            {
              "pluginVersion": "string",
              "state": "string"
            }
          ]
        }
      ]
    }
  ]
}

Аноним

Поиск

ЕдиныйАгент на хосте: различия между версиями

Пространства имён

Ещё

Действия на странице

Версия 09:00, 11 октября 2022

Содержание

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

Параметры

Ответ

Коды ответов

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

Объект _ `HostsListPage`

Объект _ `HostAgentInfo`

Объект _ `Host`

Объект _ `TagInfo`

Объект _ `EntityShortRepresentation`

Объект _ `AgentVersion`

Объект _ `HostGroup`

Объект _ `TechnologyInfo`

Объект _ `ModuleInfo`

Объект _ `ModuleInstance`

Объект _ `PluginInfo`

Объект _ `PluginInstance`

JSON-модель тела ответа

Навигация

Навигация

Вики-инструменты

Вики-инструменты

@@ Строка 1: / Строка 1: @@
+ЕдиныйАгент на хосте API позволяет вам проверять конфигурацию экземпляров ЕдиныйАгент на ваших хостах.
-OneAgent на хосте API позволяет вам проверять конфигурацию экземпляров OneAgent на ваших хостах.
 Запрос создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="2" |GET
-|Удалось
+|Managed
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/oneagents</nowiki></code>
-|-
-|SaaS
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/oneagents</nowiki></code>
 |-
 |Окружающая среда ActiveGate
@@ Строка 17: / Строка 13: @@
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 24: / Строка 20: @@
 !Тип
 !Описание
-!В
+!In
 !Необходимый
 |-
-|включитьДетали
+|includeDetails
-|логический
+|boolean
 |Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.
@@ Строка 34: / Строка 30: @@
 Если не установлено, то <code>true</code>используется.
-|запрос
+|query
 |по желанию
 |-
 |startTimestamp
-|целое число
+|integer
 |Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).
 Если не задано, используется отставание на 72 часа.
-|запрос
+|query
 |по желанию
 |-
 |endTimestamp
-|целое число
+|integer
 |Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).
@@ Строка 52: / Строка 48: @@
 Срок не должен превышать 7 месяцев (214 дней).
-|запрос
+|query
 |по желанию
 |-
 |относительное время
-|нить
+|string
 |Относительный период времени, начиная с настоящего времени.
@@ Строка 75: / Строка 71: @@
 * <code>month</code>
 * <code>week</code>
-|запрос
+|query
 |по желанию
 |-
 |ярлык
-|строка []
+|string []
 |Фильтрует результирующий набор хостов по указанному тегу. Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Хост должен соответствовать всем указанным тегам.
 В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: <code>tag=[context]key:value</code>. Для пользовательских тегов "ключ-значение" не указывайте контекст: <code>tag=key:value</code>.
-|запрос
+|query
 |по желанию
 |-
 |организация
-|строка []
+|string []
 |Фильтры приводят только к указанным хостам.
 Для указания нескольких хостов используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
-|запрос
+|query
 |по желанию
 |-
 |managementZoneId
-|целое число
+|integer
 |Возвращать только те хосты, которые входят в указанную зону управления.
 Укажите здесь идентификатор зоны управления.
-|запрос
+|query
 |по желанию
 |-
 |Зона управления
-|нить
+|string
 |Возвращать только те хосты, которые входят в указанную зону управления.
@@ Строка 109: / Строка 105: @@
 Если задан параметр managementZoneId , этот параметр игнорируется.
-|запрос
+|query
 |по желанию
 |-
 |networkZoneId
-|нить
+|string
 |Фильтрует результирующий набор хостов по указанной сетевой зоне.
 Укажите идентификатор объекта Dynatrace требуемой сетевой зоны. Вы можете получить список доступных сетевых зон с помощью вызова GET all network zone .
-|запрос
+|query
 |по желанию
 |-
 |hostGroupId
-|нить
+|string
 |Фильтрует результирующий набор хостов по указанной группе хостов.
 Укажите идентификатор объекта Dynatrace требуемой группы хостов.
-|запрос
+|query
 |по желанию
 |-
 |hostGroupName
-|нить
+|string
 |Фильтрует результирующий набор хостов по указанной группе хостов.
 Укажите имя требуемой группы хостов.
-|запрос
+|query
 |по желанию
 |-
 |тип ОС
-|нить
+|string
 |Фильтрует результирующий набор хостов по типу ОС.
@@ Строка 149: / Строка 145: @@
 * <code>WINDOWS</code>
 * <code>ZOS</code>
-|запрос
+|query
 |по желанию
 |-
 |тип облака
-|нить
+|string
 |Фильтрует результирующий набор хостов по типу облака.
@@ Строка 164: / Строка 160: @@
 * <code>ORACLE</code>
 * <code>UNRECOGNIZED</code>
-|запрос
+|query
 |по желанию
 |-
 |автоинъекция
-|нить
+|string
 |Фильтрует результирующий набор хостов по статусу автоматической инъекции.
@@ Строка 178: / Строка 174: @@
 * <code>ENABLED</code>
 * <code>FAILED_ON_INSTALLATION</code>
-|запрос
+|query
 |по желанию
 |-
 |состояние доступности
-|нить
+|string
 |Фильтрует результирующий набор хостов по состоянию доступности OneAgent.
@@ Строка 204: / Строка 200: @@
 * <code>UNKNOWN</code>
 * <code>UNMONITORED</code>
-|запрос
+|query
 |по желанию
 |-
 |подробныйAvailabilityState
-|нить
+|string
 |Фильтрует результирующий набор хостов по подробному состоянию доступности OneAgent.
@@ Строка 276: / Строка 272: @@
 * <code>UNMONITORED_TERMINATED</code>
 * <code>UNMONITORED_UNKNOWN</code>
-|запрос
+|query
 |по желанию
 |-
 |Тип мониторинга
-|нить
+|string
 |Фильтрует результирующий набор узлов по режиму мониторинга OneAgent, развернутого на узле.
@@ Строка 288: / Строка 284: @@
 * <code>FULL_STACK</code>
 * <code>STANDALONE</code>
-|запрос
+|query
 |по желанию
 |-
 |агентверсионис
-|нить
+|string
 |Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия OneAgent.
@@ Строка 304: / Строка 300: @@
 * <code>LOWER</code>
 * <code>LOWER_EQUAL</code>
-|запрос
+|query
 |по желанию
 |-
 |номер версии агента
-|нить
+|string
 |Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия OneAgent.
 Укажите версию в <code><major>.<minor>.<revision></code>формате, например <code>1.182.0</code>. Вы можете получить список доступных версий с помощью вызова доступных версий GET .
-|запрос
+|query
 |по желанию
 |-
 |autoUpdateSetting
-|нить
+|string
 |Фильтрует результирующий набор узлов по фактическому состоянию параметра автоматического обновления развернутых агентов OneAgent.
@@ Строка 323: / Строка 319: @@
 * <code>ENABLED</code>
 * <code>DISABLED</code>
-|запрос
+|query
 |по желанию
 |-
 |обновить состояние
-|нить
+|string
 |Фильтрует результирующий набор узлов по статусу обновления OneAgent, развернутого на узле.
@@ Строка 341: / Строка 337: @@
 * <code>UPDATE_PENDING</code>
 * <code>UPDATE_PROBLEM</code>
-|запрос
+|query
 |по желанию
 |-
 |ошибочная версия
-|логический
+|boolean
 |Отфильтровывает результирующий набор хостов, выбирая те, на которых работает версия OneAgent, помеченная как неисправная.
-|запрос
+|query
 |по желанию
 |-
 |ActiveGateId
-|нить
+|string
 |Отфильтровывает результирующий набор хостов на те, которые в данный момент подключены к ActiveGate с указанным ID.
 Используйте ключевое слово DIRECT_COMMUNICATION , чтобы найти хосты, не подключенные ни к одному ActiveGate.
-|запрос
+|query
 |по желанию
 |-
 |технологияModuleType
-|нить
+|string
 |Отфильтровывает результирующий набор хостов до тех, на которых работает указанный модуль кода OneAgent.
@@ Строка 387: / Строка 383: @@
 * <code>VARNISH</code>
 * <code>Z_OS</code>
-|запрос
+|query
 |по желанию
 |-
 |технологияModuleVersionIs
-|нить
+|string
 |Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода.
@@ Строка 405: / Строка 401: @@
 * <code>LOWER</code>
 * <code>LOWER_EQUAL</code>
-|запрос
+|query
 |по желанию
 |-
 |номер_версии_модуля_технологии
-|нить
+|string
 |Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода.
@@ Строка 415: / Строка 411: @@
 Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам.
-|запрос
+|query
 |по желанию
 |-
 |технологияModuleFaultyVersion
-|логический
+|boolean
 |Отфильтровывает результирующий набор хостов до тех, на которых работает версия модуля кода, помеченная как неисправная.
 Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам.
-|запрос
+|query
 |по желанию
 |-
 |имя_плагина
-|нить
+|string
 |Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным именем.
@@ Строка 433: / Строка 429: @@
 Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам.
-|запрос
+|query
 |по желанию
 |-
 |pluginVersionIs
-|нить
+|string
 |Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина.
@@ Строка 451: / Строка 447: @@
 * <code>LOWER</code>
 * <code>LOWER_EQUAL</code>
-|запрос
+|query
 |по желанию
 |-
 |номер версии плагина
-|нить
+|string
 |Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина.
@@ Строка 463: / Строка 459: @@
 Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам.
-|запрос
+|query
 |по желанию
 |-
 |состояние плагина
-|нить
+|string
 |Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным состоянием.
@@ Строка 486: / Строка 482: @@
 * <code>UNSUPPORTED</code>
 * <code>WAITING_FOR_STATE</code>
-|запрос
+|query
 |по желанию
 |-
 |ключ следующей страницы
-|нить
+|string
 |Курсор для следующей страницы результатов, если результаты не помещаются на одной странице. Вы можете найти значение курсора на текущей странице ответа, в поле nextPageKey .
@@ Строка 496: / Строка 492: @@
 Если вы не укажете курсор, всегда будет возвращаться первая страница.
-|запрос
+|query
 |по желанию
 |}

Аноним

Поиск

ЕдиныйАгент на хосте: различия между версиями

Версия 09:00, 11 октября 2022

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

Параметры

Ответ

Коды ответов

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

Объект _ HostsListPage

Объект _ HostAgentInfo

Объект _ Host

Объект _ TagInfo

Объект _ EntityShortRepresentation

Объект _ AgentVersion

Объект _ HostGroup

Объект _ TechnologyInfo

Объект _ ModuleInfo

Объект _ ModuleInstance

Объект _ PluginInfo

Объект _ PluginInstance

JSON-модель тела ответа

Навигация

Вики-инструменты

Инструменты для страниц

Объект _ `HostsListPage`

Объект _ `HostAgentInfo`

Объект _ `Host`

Объект _ `TagInfo`

Объект _ `EntityShortRepresentation`

Объект _ `AgentVersion`

Объект _ `HostGroup`

Объект _ `TechnologyInfo`

Объект _ `ModuleInfo`

Объект _ `ModuleInstance`

Объект _ `PluginInfo`

Объект _ `PluginInstance`