ЕдиныйАгент на хосте
Материал из Документация Ключ-АСТРОМ
Версия от 09:37, 11 октября 2022; ENetrebin (обсуждение | вклад)
ЕдиныйАгент на хосте API позволяет вам проверять конфигурацию экземпляров ЕдиныйАгент на ваших хостах.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/oneagents
|
| Среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/oneagents
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимый |
|---|---|---|---|---|
| includeDetails | boolean | Включает ( true) или исключает ( false) детали, которые запрашиваются у связанных объектов.
Исключение сведений может ускорить запросы. Если не установлено, то |
query | по желанию |
| startTimestamp | integer | Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется отставание на 72 часа. |
query | по желанию |
| endTimestamp | integer | Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется текущая метка времени. Срок не должен превышать 7 месяцев (214 дней). |
query | по желанию |
| relativeTime | string | Относительный период времени, начиная с настоящего времени.
Если вам нужно указать относительный период времени, который не представлен в списке возможных значений, укажите startTimestamp (до 214 дней назад) и оставьте endTimestamp и relativeTime пустыми. Элемент может содержать эти значения
|
query | по желанию |
| tag | string [] | Фильтрует результирующий набор хостов по указанному тегу. Вы можете указать несколько тегов в следующем формате: tag=tag1&tag=tag2. Хост должен соответствовать всем указанным тегам.
В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: |
query | по желанию |
| entity | string [] | Фильтры приводят только к указанным хостам.
Для указания нескольких хостов используйте следующий формат: |
query | по желанию |
| managementZoneId | integer | Возвращать только те хосты, которые входят в указанную зону управления.
Укажите здесь идентификатор зоны управления. |
query | по желанию |
| Зона управления | string | Возвращать только те хосты, которые входят в указанную зону управления.
Укажите здесь имя зоны управления. Если задан параметр managementZoneId , этот параметр игнорируется. |
query | по желанию |
| networkZoneId | string | Фильтрует результирующий набор хостов по указанной сетевой зоне.
Укажите идентификатор объекта Ключ-АСТРОМ требуемой сетевой зоны. Вы можете получить список доступных сетевых зон с помощью вызова GET all network zone . |
query | по желанию |
| hostGroupId | string | Фильтрует результирующий набор хостов по указанной группе хостов.
Укажите идентификатор объекта Ключ-АСТРОМ требуемой группы хостов. |
query | по желанию |
| hostGroupName | string | Фильтрует результирующий набор хостов по указанной группе хостов.
Укажите имя требуемой группы хостов. |
query | по желанию |
| osType | string | Фильтрует результирующий набор хостов по типу ОС.
Элемент может содержать эти значения
|
query | по желанию |
| cloudType | string | Фильтрует результирующий набор хостов по типу облака.
Элемент может содержать эти значения
|
query | по желанию |
| autoInjection | string | Фильтрует результирующий набор хостов по статусу автоматической инъекции.
Элемент может содержать эти значения
|
query | по желанию |
| availabilityState | string | Фильтрует результирующий набор хостов по состоянию доступности ЕдиногоАгента.
Элемент может содержать эти значения
|
query | по желанию |
| detailedAvailabilityState | string | Фильтрует результирующий набор хостов по подробному состоянию доступности ЕдиногоАгента.
Элемент может содержать эти значения
|
query | по желанию |
| monitoringType | string | Фильтрует результирующий набор узлов по режиму мониторинга ЕдиногоАгента, развернутого на узле.
Элемент может содержать эти значения
|
query | по желанию |
| agentVersionIs | string | Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия ЕдиногоАгента.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
query | по желанию |
| agentVersionNumber | string | Отфильтровывает результирующий набор хостов по тем, на которых развернута определенная версия ЕдиногоАгента.
Укажите версию в |
query | по желанию |
| autoUpdateSetting | string | Фильтрует результирующий набор узлов по фактическому состоянию параметра автоматического обновления развернутых ЕдиныхАгентов.
Элемент может содержать эти значения
|
query | по желанию |
| updateStatus | string | Фильтрует результирующий набор узлов по статусу обновления ЕдиногоАгента, развернутого на узле.
Элемент может содержать эти значения
|
query | по желанию |
| faultyVersion | boolean | Отфильтровывает результирующий набор хостов, выбирая те, на которых работает версия ЕдиногоАгента, помеченная как неисправная. | query | по желанию |
| ActiveGateId | string | Отфильтровывает результирующий набор хостов на те, которые в данный момент подключены к АктивномуШлюзу с указанным ID.
Используйте ключевое слово DIRECT_COMMUNICATION , чтобы найти хосты, не подключенные ни к одному АктивномуШлюзу. |
query | по желанию |
| technologyModuleType | string | Отфильтровывает результирующий набор хостов до тех, на которых работает указанный модуль кода ЕдиногоАгента.
Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. Элемент может содержать эти значения
|
query | по желанию |
| technologyModuleVersionIs | string | Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода.
Укажите здесь оператор сравнения. Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. Элемент может содержать эти значения
|
query | по желанию |
| technologyModuleVersionNumber | string | Отфильтровывает результирующий набор хостов для тех, на которых развернута определенная версия модуля кода.
Укажите версию в Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. |
query | по желанию |
| technologyModuleFaultyVersion | boolean | Отфильтровывает результирующий набор хостов до тех, на которых работает версия модуля кода, помеченная как неисправная.
Если указано несколько фильтров модуля кода, модуль кода должен соответствовать всем фильтрам. |
query | по желанию |
| pluginName | string | Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным именем.
Оператор CONTAINS применяется к указанному значению. Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам. |
query | по желанию |
| pluginVersionIs | string | Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина.
Укажите здесь оператор сравнения. Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам. Элемент может содержать эти значения
|
query | по желанию |
| pluginVersionNumber | string | Отфильтровывает результирующий набор хостов до тех, на которых развернута определенная версия плагина.
Укажите версию в
Если указано несколько фильтров плагина, плагин должен соответствовать всем фильтрам. |
query | по желанию |
| pluginState | string | Отфильтровывает результирующий набор хостов до тех, на которых работает плагин с указанным состоянием.
Элемент может содержать эти значения
|
query | по желанию |
| nextPageKey | string | Курсор для следующей страницы результатов, если результаты не помещаются на одной странице. Вы можете найти значение курсора на текущей странице ответа, в поле nextPageKey .
Чтобы получить последующие страницы, вы должны указать это значение курсора в своем запросе, а все остальные параметры запроса оставить такими, какими они были в исходном запросе. Если вы не укажете курсор, всегда будет возвращаться первая страница. |
query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Страница со списком хостов | Успех |
Объекты тела ответа
Объект _ HostsListPage
Список хостов с информацией о развертывании OneAgent для каждого хоста.
| Элемент | Тип | Описание |
|---|---|---|
| процент среды | количество | Ход поиска среды в процентах. |
| ключ следующей страницы | нить | Курсор для следующей страницы результатов.
Имеет значение Может быть другая страница результатов, даже если текущая страница пуста. |
| хозяева | Информация об агенте хоста [] | Список хостов с информацией о развертывании OneAgent для каждого хоста. |
Объект _ HostAgentInfo
Развертывание OneAgent на хосте.
| Элемент | Тип | Описание |
|---|---|---|
| информация о хосте | Хозяин | Информация о хозяине. |
| ошибочная версия | логический | Версия OneAgent ошибочна ( true) или нет ( false).
|
| активный | логический | OneAgent активен ( true) или неактивен ( false).
|
| сконфигурированныйМониторингМоде | нить | Настроен режим мониторинга OneAgent.
Элемент может содержать эти значения
|
| Тип мониторинга | нить | Режим мониторинга OneAgent.
Элемент может содержать эти значения
|
| autoUpdateSetting | нить | Эффективная настройка автоматического обновления OneAgent. Для хоста с унаследованной конфигурацией он рассчитывается на основе конфигурации его родителя.
Элемент может содержать эти значения
|
| обновить состояние | нить | Текущий статус обновления OneAgent.
Элемент может содержать эти значения
|
| доступные версии | строка [] | Список версий OneAgent, до которых можно обновить. |
| сконфигурированныймониторингенаблед | логический | Мониторинг включен ( true) или отключен ( false) в конфигурации OneAgent.
|
| состояние доступности | нить | Состояние доступности OneAgent.
Элемент может содержать эти значения
|
| подробныйAvailabilityState | нить | Подробное состояние доступности OneAgent.
Элемент может содержать эти значения
|
| целое число | УСТАРЕЛО
Это поле устарело и предназначено для обратной совместимости. Вместо этого используйте поле currentActiveGateIds . | |
| currentActiveGateIds | строка [] | Список идентификаторов ActiveGate для ActiveGate, к которым в данный момент подключен OneAgent. |
| currentNetworkZoneId | нить | Идентификатор сетевой зоны, которую использует OneAgent. |
| модули | Информация о модуле [] | Список модулей кода, развернутых на хосте. |
| плагины | Информация о плагине [] | Список плагинов, развернутых на хосте. |
Объект _ Host
Информация о хозяине.
| Элемент | Тип | Описание |
|---|---|---|
| идентификатор объекта | нить | Идентификатор объекта Dynatrace требуемого объекта. |
| показать имя | нить | Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе. |
| индивидуальное имя | нить | Пользовательское имя объекта |
| обнаружил имя | нить | Обнаруженное имя объекта |
| firstSeenTimestamp | целое число | Отметка времени первого обнаружения объекта в миллисекундах UTC. |
| lastSeenTimestamp | целое число | Отметка времени последнего обнаружения объекта в миллисекундах UTC. |
| теги | Информация о теге [] | Список тегов сущностей. |
| отОтношения | объект | - |
| кОтношения | объект | - |
| управлениеЗоны | Краткое представление объекта [] | Зоны управления, частью которых является объект. |
| localHostName | нить | - |
| openstackComputeNodeName | нить | - |
| esxiHostName | нить | - |
| режим мониторинга | нить | -
Элемент может содержать эти значения
|
| paasAgentVersions | Версия агента [] | Версии агентов PaaS, которые в настоящее время работают на объекте. |
| IP-адреса | строка [] | - |
| boshStemcellВерсия | нить | Версия стволовых клеток Cloud Foundry BOSH. |
| локальный IP | нить | - |
| тип облака | нить | -
Элемент может содержать эти значения
|
| CloudPlatformVendorVersion | нить | Определяет версию поставщика облачной платформы. |
| азуревмсизелабел | нить | - |
| зослпанаме | нить | Имя LPAR. |
| zosTotalGeneralPurposeПроцессоры | целое число | Количество назначенных процессоров для этого LPAR. |
| openstackVmName | нить | - |
| paasType | нить | -
Элемент может содержать эти значения
|
| азуревмскалесетнаме | нить | - |
| zosSystemName | нить | Название системы. |
| azureResourceGroupName | нить | - |
| networkZoneId | нить | Идентификатор сетевой зоны, в которой находится объект. |
| azureHostNames | строка [] | - |
| агентВерсия | Версия агента | Определяет версию агента, работающего в данный момент на объекте. |
| paasMemoryLimit | целое число | - |
| vmwareName | нить | - |
| потребляемыеHostUnits | нить | - |
| автоинъекция | нить | Статус автоинъекции
Элемент может содержать эти значения
|
| 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 | нить | -
Элемент может содержать эти значения
|
| awsNameTag | нить | Название унаследовано от AWS. |
| azureVmName | нить | - |
| awsInstanceType | нить | - |
| boshInstanceId | нить | Идентификатор экземпляра Cloud Foundry BOSH. |
| тип гипервизора | нить | -
Элемент может содержать эти значения
|
| одновременная многопоточность | целое число | Количество одновременных потоков экземпляра AIX. |
| gcePublicIpAddresses | строка [] | Общедоступные IP-адреса Google Compute Engine. |
| логические процессорные ядра | целое число | - |
| boshInstanceName | нить | Имя экземпляра Cloud Foundry BOSH. |
| лазурныйSku | нить | -
Элемент может содержать эти значения
|
| лазурная среда | нить | - |
| лазурная зона | нить | - |
| kubernetesкластер | нить | Кластер kubernetes, в котором находится сущность. |
| логический ЦП | целое число | Количество логических процессоров экземпляра AIX. |
| gceMachineType | нить | Тип машины Google Compute Engine. |
| openStackInstaceType | нить | - |
| битность | нить | -
Элемент может содержать эти значения
|
| gceProject | нить | Проект Google Compute Engine. |
| kubernetesLabels | объект | Метки kubernetes, определенные для объекта. |
| autoScalingGroup | нить | - |
| gceInstanceId | нить | Идентификатор экземпляра Google Compute Engine. |
| ОСВерсия | нить | - |
| среди | нить | - |
| isMonitoringCandidate | логический | - |
| oneAgentCustomHostName | нить | Пользовательское имя, указанное в конфигурации OneAgent. |
| уровень пользователя | нить | -
Элемент может содержать эти значения
|
| виртуальный процессор | целое число | Количество виртуальных процессоров экземпляра AIX. |
| программное обеспечениеТехнологии | Информация о технологии [] | - |
| awsSecurityGroup | строка [] | - |
| azureResourceId | нить | - |
| тип ОС | нить | -
Элемент может содержать эти значения
|
| openstackSecurityGroups | строка [] | - |
| ОСАрхитектура | нить | -
Элемент может содержать эти значения
|
| публичный IP | нить | - |
| zosTotalPhysicalMemory | целое число | Память, назначенная хосту (Терабайт). |
| zosCPUModelNumber | нить | Номер модели процессора. |
| openstackAvZone | нить | - |
Объект _ TagInfo
Тег сущности Dynatrace.
| Элемент | Тип | Описание |
|---|---|---|
| контекст | нить | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
| ключ | нить | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
| ценность | нить | Значение тега.
Не применимо к пользовательским тегам. |
Объект _ EntityShortRepresentation
Краткое представление объекта Dynatrace.
| Элемент | Тип | Описание |
|---|---|---|
| я бы | нить | Идентификатор объекта Dynatrace. |
| имя | нить | Имя объекта Dynatrace. |
| описание | нить | Краткое описание сущности Dynatrace. |
Объект _ AgentVersion
Определяет версию агента, работающего в данный момент на объекте.
| Элемент | Тип | Описание |
|---|---|---|
| главный | целое число | Номер основной версии. |
| незначительный | целое число | Младший номер версии. |
| ревизия | целое число | Номер ревизии. |
| отметка времени | нить | Строка временной метки: формат "ггггммдд-ччммсс |
| Исходная версия | нить | Строковое представление номера версии SVN. |
Объект _ HostGroup
| Элемент | Тип | Описание |
|---|---|---|
| meId | нить | Идентификатор объекта Dynatrace группы хостов. |
| имя | нить | Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе. |
Объект _ TechnologyInfo
| Элемент | Тип | Описание |
|---|---|---|
| тип | нить | - |
| версия | нить | - |
| версия | нить | - |
Объект _ ModuleInfo
Модуль кода OneAgent.
| Элемент | Тип | Описание |
|---|---|---|
| тип модуля | нить | Тип модуля кода.
Элемент может содержать эти значения
|
| экземпляры | Экземпляр модуля [] | Список экземпляров модуля кода. |
Объект _ 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"
}
]
}
]
}
]
}
