ЕдиныйАгент на хосте
Материал из Документация Ключ-АСТРОМ
Версия от 15:34, 21 сентября 2023; ENetrebin (обсуждение | вклад)
ЕдиныйАгент на хосте API позволяет вам проверять конфигурацию экземпляров ЕдиныйАгент на ваших хостах.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/oneagents
|
| Среда АктивногоШлюза | 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 | Успех |
Объекты тела ответа
Объект HostsListPage
Список хостов с информацией о развертывании ЕдиногоАгента для каждого хоста.
| Элемент | Тип | Описание |
|---|---|---|
| percentageOfEnvironmentSearched | number | Ход поиска среды в процентах. |
| nextPageKey | string | Курсор для следующей страницы результатов.
Имеет значение Может быть другая страница результатов, даже если текущая страница пуста. |
| hosts | HostAgentInfo[] | Список хостов с информацией о развертывании ЕдиногоАгента для каждого хоста. |
Объект HostAgentInfo
Развертывание ЕдиногоАгента на хосте.
| Элемент | Тип | Описание |
|---|---|---|
| hostInfo | Host | Информация о хозяине. |
| faultyVersion | boolean | Версия ЕдиногоАгента ошибочна ( true) или нет ( false).
|
| active | boolean | ЕдиныйАгент активен ( true) или неактивен ( false).
|
| configuredMonitoringMode | string | Настроен режим мониторинга ЕдиногоАгента.
Элемент может содержать эти значения
|
| monitoringType | string | Режим мониторинга ЕдиногоАгента.
Элемент может содержать эти значения
|
| autoUpdateSetting | string | Эффективная настройка автоматического обновления ЕдиногоАгента. Для хоста с унаследованной конфигурацией он рассчитывается на основе конфигурации его родителя.
Элемент может содержать эти значения
|
| updateStatus | string | Текущий статус обновления ЕдиногоАгента.
Элемент может содержать эти значения
|
| availableVersions | string [] | Список версий ЕдиногоАгента, до которых можно обновить. |
| configuredMonitoringEnabled | boolean | Мониторинг включен ( true) или отключен ( false) в конфигурации ЕдиногоАгента.
|
| availabilityState | string | Состояние доступности ЕдиногоАгента.
Элемент может содержать эти значения
|
| detailedAvailabilityState | string | Подробное состояние доступности ЕдиногоАгента.
Элемент может содержать эти значения
|
| integer | УСТАРЕЛО
Это поле устарело и предназначено для обратной совместимости. Вместо этого используйте поле currentActiveGateIds . | |
| currentActiveGateIds | string [] | Список идентификаторов АктивногоШлюза для АктивногоШлюза, к которым в данный момент подключен ЕдиныйАгент. |
| currentNetworkZoneId | string | Идентификатор сетевой зоны, которую использует ЕдиныйАгент. |
| modules | ModuleInfo[] | Список модулей кода, развернутых на хосте. |
| plugins | PluginInfo[] | Список плагинов, развернутых на хосте. |
Объект Host
Информация о хозяине.
| Элемент | Тип | Описание |
|---|---|---|
| entityId | string | Идентификатор объекта Ключ-АСТРОМ требуемого объекта. |
| displayName | string | Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе. |
| customizedName | string | Пользовательское имя объекта |
| discoveredName | string | Обнаруженное имя объекта |
| firstSeenTimestamp | integer | Отметка времени первого обнаружения объекта в миллисекундах UTC. |
| lastSeenTimestamp | integer | Отметка времени последнего обнаружения объекта в миллисекундах UTC. |
| tags | TagInfo[] | Список тегов сущностей. |
| fromRelationships | object | - |
| toRelationships | object | - |
| managementZones | EntityShortRepresentation[] | Зоны управления, частью которых является объект. |
| localHostName | string | - |
| openstackComputeNodeName | string | - |
| esxiHostName | string | - |
| monitoringMode | string | -
Элемент может содержать эти значения
|
| paasAgentVersions | AgentVersion[] | Версии агентов PaaS, которые в настоящее время работают на объекте. |
| ipAddresses | string [] | - |
| boshStemcellVersion | string | Версия стволовых клеток Cloud Foundry BOSH. |
| localIp | string | - |
| cloudType | string | -
Элемент может содержать эти значения
|
| CloudPlatformVendorVersion | string | Определяет версию поставщика облачной платформы. |
| azureVmSizeLabel | string | - |
| zosLpaName | string | Имя LPAR. |
| zosTotalGeneralPurposeProcessors | integer | Количество назначенных процессоров для этого LPAR. |
| openstackVmName | string | - |
| paasType | string | -
Элемент может содержать эти значения
|
| azureVmScaleSetName | string | - |
| zosSystemName | string | Название системы. |
| azureResourceGroupName | string | - |
| networkZoneId | string | Идентификатор сетевой зоны, в которой находится объект. |
| azureHostNames | string [] | - |
| agentVersion | AgentVersion | Определяет версию агента, работающего в данный момент на объекте. |
| paasMemoryLimit | integer | - |
| vmwareName | string | - |
| consumedHostUnits | string | - |
| autoInjection | string | Статус автоинжектирования
Элемент может содержать эти значения
|
| hostGroup | HostGroup | - |
| zosTotalZiipProcessors | integer | Количество назначенных процессоров поддержки для этого LPAR. |
| boshAvailabilityZone | string | Зона доступности Cloud Foundry BOSH. |
| beanstalkEnvironmentName | string | - |
| publicHostName | string | - |
| gceInstanceName | string | Имя экземпляра Google Compute Engine. |
| awsInstanceId | string | - |
| gceProjectId | string | Числовой идентификатор проекта Google Compute Engine. |
| ScaleSetName | string | - |
| openstackProjectName | string | - |
| azureSiteNames | string [] | - |
| zosCPUSerialNumber | string | Серийный номер процессора. |
| boshName | string | Название Cloud Foundry BOSH. |
| zosVirtualization | string | Тип виртуализации на мейнфрейме. |
| boshDeploymentId | string | Идентификатор развертывания Cloud Foundry BOSH. |
| gcpZone | string | Зона облачной платформы Google. |
| kubernetesNode | string | Узел kubernetes, в котором находится сущность. |
| cpuCores | integer | - |
| azureComputeModeName | string | -
Элемент может содержать эти значения
|
| awsNameTag | string | Название унаследовано от AWS. |
| azureVmName | string | - |
| awsInstanceType | string | - |
| boshInstanceId | string | Идентификатор экземпляра Cloud Foundry BOSH. |
| hypervisorType | string | -
Элемент может содержать эти значения
|
| simultaneousMultithreading | integer | Количество одновременных потоков экземпляра AIX. |
| gcePublicIpAddresses | string [] | Общедоступные IP-адреса Google Compute Engine. |
| logicalCpuCores | integer | - |
| boshInstanceName | string | Имя экземпляра Cloud Foundry BOSH. |
| azureSku | string | -
Элемент может содержать эти значения
|
| azureEnvironment | string | - |
| azureZone | string | - |
| kubernetesCluster | string | Кластер kubernetes, в котором находится сущность. |
| logicalCpus | integer | Количество логических процессоров экземпляра AIX. |
| gceMachineType | string | Тип машины Google Compute Engine. |
| openStackInstaceType | string | - |
| bitness | string | -
Элемент может содержать эти значения
|
| gceProject | string | Проект Google Compute Engine. |
| kubernetesLabels | object | Метки kubernetes, определенные для объекта. |
| autoScalingGroup | string | - |
| gceInstanceId | string | Идентификатор экземпляра Google Compute Engine. |
| osVersion | string | - |
| amiId | string | - |
| isMonitoringCandidate | boolean | - |
| oneAgentCustomHostName | string | Пользовательское имя, указанное в конфигурации ЕдиногоАгента. |
| userLevel | string | -
Элемент может содержать эти значения
|
| virtualCpus | integer | Количество виртуальных процессоров экземпляра AIX. |
| softwareTechnologies | TechnologyInfo[] | - |
| awsSecurityGroup | string [] | - |
| azureResourceId | string | - |
| osType | string | -
Элемент может содержать эти значения
|
| openstackSecurityGroups | string [] | - |
| osArchitecture | string | -
Элемент может содержать эти значения
|
| publicIp | string | - |
| zosTotalPhysicalMemory | integer | Память, назначенная хосту (Терабайт). |
| zosCPUModelNumber | string | Номер модели процессора. |
| openstackAvZone | string | - |
Объект TagInfo
Тег сущности Ключ-АСТРОМ.
| Элемент | Тип | Описание |
|---|---|---|
| context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
| key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
| value | string | Значение тега.
Не применимо к пользовательским тегам. |
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор объекта Ключ-АСТРОМ. |
| name | string | Имя объекта Ключ-АСТРОМ. |
| description | string | Краткое описание сущности Ключ-АСТРОМ. |
Объект AgentVersion
Определяет версию агента, работающего в данный момент на объекте.
| Элемент | Тип | Описание |
|---|---|---|
| major | integer | Номер основной версии. |
| minor | integer | Младший номер версии. |
| revision | integer | Номер ревизии. |
| timestamp | string | Строка временной метки: формат "ггггммдд-ччммсс |
| sourceRevision | string | Строковое представление номера версии SVN. |
Объект HostGroup
| Элемент | Тип | Описание |
|---|---|---|
| meId | string | Идентификатор объекта Ключ-АСТРОМ группы хостов. |
| name | string | Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе. |
Объект TechnologyInfo
| Элемент | Тип | Описание |
|---|---|---|
| type | string | - |
| edition | string | - |
| version | string | - |
Объект ModuleInfo
Модуль кода ЕдиныйАгент.
| Элемент | Тип | Описание |
|---|---|---|
| moduleType | string | Тип модуля кода.
Элемент может содержать эти значения
|
| instances | ModuleInstance[] | Список экземпляров модуля кода. |
Объект ModuleInstance
Экземпляр модуля кода ЕдиногоАгента.
| Элемент | Тип | Описание |
|---|---|---|
| instanceName | string | Имя экземпляра. |
| moduleVersion | string | Версия модуля кода. |
| faultyVersion | boolean | Версия кодового модуля ошибочна ( true) или нет ( false).
|
| active | boolean | Экземпляр модуля кода активен ( true) или неактивен ( false).
|
Объект PluginInfo
Плагин ЕдиногоАгента.
| Элемент | Тип | Описание |
|---|---|---|
| pluginName | string | Название плагина. |
| instances | PluginInstance[] | Список экземпляров плагина. |
Объект PluginInstance
Экземпляр подключаемого модуля ЕдиногоАгента.
| Элемент | Тип | Описание |
|---|---|---|
| pluginVersion | string | Версия плагина. |
| state | string | Состояние экземпляра плагина. |
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": "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"
},
"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"
}
]
}
]
}
]
}
