GET все процессы

Получает список всех процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и взаимосвязями.

Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.

Вы можете дополнительно ограничить вывод с помощью нумерации страниц:

Укажите количество результатов на странице в параметре запроса pageSize .
Затем используйте курсор из заголовка ответа Next-Page-Key в параметре запроса nextPageKey для получения последующих страниц.

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

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

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

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

Параметры

Срок ограничен максимальным периодом в 3 дня .

Параметр	Тип	Описание	In	Необходимость
startTimestamp	integer	Метка времени начала запрошенного таймфрейма в миллисекундах (UTC). Если не задано, используется отставание на 72 часа.	query	по желанию
endTimestamp	integer	Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC). Если не задано, используется текущая метка времени. Срок не должен превышать 3 дней.	query	по желанию
relativeTime	string	Относительный период времени, начиная с настоящего времени. Элемент может содержать эти значения `min` `5mins` `10mins` `15mins` `30mins` `hour` `2hours` `6hours` `day` `3days`	query	по желанию
tag	string []	Фильтрует результирующий набор процессов по указанному тегу. Вы можете указать несколько тегов в следующем формате: `tag=tag1&tag=tag2`. Процесс должен соответствовать всем указанным тегам. В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: `tag=[context]key:value`. Для пользовательских тегов "ключ-значение" не указывайте контекст: `tag=key:value`.	query	по желанию
entity	string []	Фильтры приводят только к указанным процессам. Чтобы указать несколько процессов, используйте следующий формат: `entity=ID1&entity=ID2`.	query	по желанию
hostTag	string []	Фильтрует процессы по узлу, на котором они запущены. Укажите теги интересующего вас хоста.	query	по желанию
host	string []	Фильтрует процессы по узлу, на котором они запущены. Укажите Ключ-АСТРОМ ID интересующего вас хоста. Для указания нескольких хостов используйте следующий формат: `host=hostID1&host=hostID2`. Применяется логика ИЛИ .	query	по желанию
actualMonitoringState	string	Фильтрует процессы по фактическому состоянию мониторинга процесса. Элемент может содержать эти значения `OFF` `ON`	query	по желанию
expectedMonitoringState	string	Фильтрует процессы по ожидаемому состоянию мониторинга процесса. Элемент может содержать эти значения `OFF` `ON`	query	по желанию
managementZone	integer	Возвратите только процессы, которые являются частью указанной зоны управления.	query	по желанию
includeDetails	boolean	Включает ( `true`) или исключает ( `false`) детали, которые запрашиваются у связанных объектов. Исключение сведений может ускорить запросы. Если не установлено, то `true`используется.	query	по желанию
pageSize	integer	Количество процессов на странице результатов. Если не задано, нумерация страниц не используется, и результат содержит все процессы, соответствующие заданным критериям фильтрации.	query	по желанию
nextPageKey	string	Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа. Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора. Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	ProcessGroupInstance[]	Успех
400	ErrorEnvelope	Не удалось. Ввод недействителен.

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

Объект `ResponseBody`

Объект не предоставляет никаких параметров.

Объект `ProcessGroupInstance`

Параметры процесса.

Элемент	Тип	Описание
entityId	string	Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
displayName	string	Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
customizedName	string	Пользовательское имя объекта
discoveredName	string	Обнаруженное имя объекта
firstSeenTimestamp	integer	Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp	integer	Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags	TagInfo[]	Список тегов сущностей.
fromRelationships	объект	-
toRelationships	объект	-
metadata	объект	-
softwareTechnologies	TechnologyInfo[]	-
azureSiteName	string	-
versionedModules	ProcessGroupInstanceModule[]	-
managementZones	EntityShortRepresentation[]	Зоны управления, частью которых является объект.
modules	string []	-
agentVersions	AgentVersion[]	Версии ЕдиныхАгентов, которые в настоящее время работают на объекте.
listenPorts	integer []	-
bitness	string	- Элемент может содержать эти значения `32bit` `64bit`
azureHostName	string	-
monitoringState	MonitoringState	Определяет текущее состояние мониторинга объекта.

Объект _ `TagInfo`

Тег сущности Ключ-АСТРОМ.

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

Объект _ `EntityShortRepresentation`

Краткое представление объекта Ключ-АСТРОМ.

Элемент	Тип	Описание
я бы	string	Идентификатор объекта Ключ-АСТРОМ.
имя	string	Имя объекта Ключ-АСТРОМ.
описание	string	Краткое описание сущности Ключ-АСТРОМ.

Объект _ `MonitoringState`

Определяет текущее состояние мониторинга объекта.

Элемент	Тип	Описание
фактическое состояние мониторинга	string	Текущее фактическое состояние мониторинга объекта. Элемент может содержать эти значения `OFF` `ON`
ожидаемое состояние мониторинга	string	Состояние мониторинга, ожидаемое от конфигурации Элемент может содержать эти значения `OFF` `ON`
перезапускОбязательный	логический	Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг

Объект _ `ProcessGroupInstanceModule`

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

Объект _ `AgentVersion`

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

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

Объект _ `TechnologyInfo`

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

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

[
  {
    "entityId": "string",
    "displayName": "string",
    "customizedName": "string",
    "discoveredName": "string",
    "firstSeenTimestamp": 1,
    "lastSeenTimestamp": 1,
    "tags": [
      {
        "context": "AWS",
        "key": "string",
        "value": "string"
      }
    ],
    "fromRelationships": {
      "isProcessOf": [
        "string"
      ],
      "isInstanceOf": [
        "string"
      ],
      "isNetworkClientOf": [
        "string"
      ]
    },
    "toRelationships": {
      "runsOnProcessGroupInstance": [
        "string"
      ],
      "isNetworkClientOf": [
        "string"
      ]
    },
    "metadata": {
      "hostGroups": [
        "string"
      ],
      "cloudFoundryAppIds": [
        "string"
      ],
      "AstromkeyNodeIds": [
        "string"
      ],
      "executables": [
        "string"
      ],
      "googleComputeEngineMetadata": {},
      "phpScripts": [
        "string"
      ],
      "awsEcsCluster": [
        "string"
      ],
      "declarativeId": [
        "string"
      ],
      "glassfishInstanceNames": [
        "string"
      ],
      "tibcoBusinessWorksEnginePropertyFiles": [
        "string"
      ],
      "jbossServerNames": [
        "string"
      ],
      "catalinaBaseValues": [
        "string"
      ],
      "mssqlInstanceName": [
        "string"
      ],
      "ibmIntegrationServerName": [
        "string"
      ],
      "varnishInstanceNames": [
        "string"
      ],
      "phpWorkingDirectories": [
        "string"
      ],
      "websphereLibertyServerName": [
        "string"
      ],
      "googleCloudProjects": [
        "string"
      ],
      "dockerContainerImageVersions": [
        "string"
      ],
      "hybrisConfigDirectories": [
        "string"
      ],
      "executablePaths": [
        "string"
      ],
      "awsEcrImageRegions": [
        "string"
      ],
      "tibcoBusinessWorksAppSpaceName": [
        "string"
      ],
      "springBootStartupClass": [
        "string"
      ],
      "weblogicDomainNames": [
        "string"
      ],
      "elasticSearchNodeNames": [
        "string"
      ],
      "tibcoBWEnginePropertyFilePaths": [
        "string"
      ],
      "kubernetesContainerNames": [
        "string"
      ],
      "rubyAppRootPaths": [
        "string"
      ],
      "ibmImsMessageProcessingRegions": [
        "string"
      ],
      "linkage": [
        "string"
      ],
      "cloudfoundryMetadata": {},
      "oracleSid": [
        "string"
      ],
      "awsEcsFamily": [
        "string"
      ],
      "commandLineArgs": [
        "string"
      ],
      "aspDotNetCoreApplicationPaths": [
        "string"
      ],
      "awsEcrImageAccountIds": [
        "string"
      ],
      "springBootAppName": [
        "string"
      ],
      "websphereClusterNames": [
        "string"
      ],
      "springBootProfileName": [
        "string"
      ],
      "kubernetesAnnotations": {},
      "websphereServerNames": [
        "string"
      ],
      "catalinaHomeValues": [
        "string"
      ],
      "glassfishDomainNames": [
        "string"
      ],
      "kubernetesBasePodNames": [
        "string"
      ],
      "weblogicClusterNames": [
        "string"
      ],
      "javaMainModules": [
        "string"
      ],
      "kubernetesPodUids": [
        "string"
      ],
      "awsEcsContainerName": [
        "string"
      ],
      "coldfusionJvmConfigFiles": [
        "string"
      ],
      "dotnetCommandPath": [
        "string"
      ],
      "tibcoBusinessWorksDomainName": [
        "string"
      ],
      "elasticSearchClusterNames": [
        "string"
      ],
      "nodejsScriptNames": [
        "string"
      ],
      "iisRoleNames": [
        "string"
      ],
      "apacheSparkMasterIpAddresses": [
        "string"
      ],
      "weblogicNames": [
        "string"
      ],
      "rubyScriptPaths": [
        "string"
      ],
      "ibmImsSoapGwName": [
        "string"
      ],
      "nodejsAppBaseDirectories": [
        "string"
      ],
      "softwareAgProductPropertyName": [
        "string"
      ],
      "awsEcsRevision": [
        "string"
      ],
      "ibmImsControlRegions": [
        "string"
      ],
      "javaMainClasses": [
        "string"
      ],
      "cassandraClusterNames": [
        "string"
      ],
      "softwareAgInstallRoot": [
        "string"
      ],
      "cloudFoundryAppNames": [
        "string"
      ],
      "cloudFoundrySpaceNames": [
        "string"
      ],
      "pluginMetadata": {},
      "ibmIntegrationNodeName": [
        "string"
      ],
      "dockerContainerNames": [
        "string"
      ],
      "ibmCtgName": [
        "string"
      ],
      "tibcoBusinessWorksCeAppName": [
        "string"
      ],
      "kubernetesFullPodNames": [
        "string"
      ],
      "apacheConfigPaths": [
        "string"
      ],
      "tibcoBusinessWorksAppNodeName": [
        "string"
      ],
      "tibcoBusinessWorksCeVersion": [
        "string"
      ],
      "dotNetCommands": [
        "string"
      ],
      "googleAppEngineServices": [
        "string"
      ],
      "kubernetesNamespaces": [
        "string"
      ],
      "hybrisDataDirectories": [
        "string"
      ],
      "envVariables": {},
      "javaJarFiles": [
        "string"
      ],
      "javaJarPaths": [
        "string"
      ],
      "dockerContainerIds": [
        "string"
      ],
      "cloudFoundrySpaceIds": [
        "string"
      ],
      "ruleResult": [
        "string"
      ],
      "kubernetesRuleResult": [
        "string"
      ],
      "jbossModes": [
        "string"
      ],
      "awsLambdaFunctionNames": [
        "string"
      ],
      "cloudFoundryInstanceIndexes": [
        "string"
      ],
      "hybrisBinDirectories": [
        "string"
      ],
      "weblogicHomeValues": [
        "string"
      ],
      "jbossHomes": [
        "string"
      ],
      "AstromkeyClusterIds": [
        "string"
      ],
      "googleAppEngineInstances": [
        "string"
      ],
      "websphereNodeNames": [
        "string"
      ],
      "agentValueMetadata": {},
      "iisAppPools": [
        "string"
      ],
      "ibmImsConnectRegions": [
        "string"
      ],
      "dockerContainerImageNames": [
        "string"
      ],
      "tibcoBusinessWorksHome": [
        "string"
      ],
      "ibmCicsRegion": [
        "string"
      ],
      "serviceNames": [
        "string"
      ],
      "websphereCellNames": [
        "string"
      ],
      "nodejsAppNames": [
        "string"
      ],
      "equinoxConfigPath": [
        "string"
      ],
      "awsRegions": [
        "string"
      ]
    },
    "managementZones": [
      {
        "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
        "name": "Astromkey entity",
        "description": "Astromkey entity for the REST API example"
      }
    ],
    "modules": [
      "string"
    ],
    "monitoringState": {
      "actualMonitoringState": "OFF",
      "expectedMonitoringState": "OFF",
      "restartRequired": true
    },
    "azureHostName": "string",
    "azureSiteName": "string",
    "listenPorts": [
      1
    ],
    "versionedModules": [
      {
        "name": "string",
        "version": "string"
      }
    ],
    "agentVersions": [
      {
        "major": 1,
        "minor": 1,
        "revision": 1,
        "timestamp": "string",
        "sourceRevision": "string"
      }
    ],
    "softwareTechnologies": [
      {
        "type": "string",
        "edition": "string",
        "version": "string"
      }
    ],
    "bitness": "32bit"
  }
]

Заголовки ответа

Заголовок	Тип	Описание
Общее количество	integer	Предполагаемое количество результатов.
Клавиша следующей страницы	string	Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
Размер страницы	string	Максимальное количество результатов на странице.

Пример

В этом примере в запросе перечислены все процессы в вашей среде Ключ-АСТРОМ, обнаруженные за последние 5 минут .

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

Результат усекается до двух записей.

Завиток

curl -X GET \
  'https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins

Тело ответа

[
  {
    "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
    "displayName": "Apache Web Server apache2",
    "discoveredName": "Apache Web Server apache2",
    "firstSeenTimestamp": 1464951001104,
    "lastSeenTimestamp": 1544024894801,
    "tags": [],
    "fromRelationships": {
      "isProcessOf": [
        "HOST-5FD609AD6757BE7D"
      ],
      "isInstanceOf": [
        "PROCESS_GROUP-B34081EFF9E5F516"
      ]
    },
    "toRelationships": {
      "runsOnProcessGroupInstance": [
        "SERVICE-C3173FEB08025322",
        "SERVICE-B8C88BAA442098CF"
      ]
    },
    "metadata": {
      "commandLineArgs": [
        "/usr/sbin/apache2 -k start"
      ],
      "executables": [
        "apache2"
      ],
      "executablePaths": [
        "/usr/sbin/apache2"
      ],
      "apacheConfigPaths": [
        "/etc/apache2/apache2.conf"
      ]
    },
    "softwareTechnologies": [
      {
        "type": "PHP",
        "edition": "Apache",
        "version": "5.5.9"
      },
      {
        "type": "APACHE_HTTPD",
        "edition": null,
        "version": "2.4.7"
      },
      {
        "type": "SQLITE",
        "edition": null,
        "version": null
      }
    ],
    "listenPorts": [
      443,
      80
    ],
    "bitness": "64bit",
    "monitoringState": {
      "actualMonitoringState": "ON",
      "expectedMonitoringState": "ON",
      "restartRequired": false
    },
    "agentVersions": [
      {
        "major": 1,
        "minor": 157,
        "revision": 167,
        "timestamp": "20181127-152923",
        "sourceRevision": ""
      }
    ]
  },
  {
    "entityId": "PROCESS_GROUP_INSTANCE-C43E52A77ED8F809",
    "displayName": "OneAgent network monitoring",
    "discoveredName": "OneAgent network monitoring",
    "firstSeenTimestamp": 1543571247077,
    "lastSeenTimestamp": 1544024847791,
    "tags": [
      {
        "context": "CONTEXTLESS",
        "key": "sample tag"
      }
    ],
    "fromRelationships": {
      "isProcessOf": [
        "HOST-CCEA78FDE257A4B9"
      ],
      "isInstanceOf": [
        "PROCESS_GROUP-E2B399E9E7FF43C0"
      ],
      "isNetworkClientOf": [
        "PROCESS_GROUP_INSTANCE-9E7865921C2C984E"
      ]
    },
    "toRelationships": {},
    "metadata": {
      "hostGroups": [
        "wazuh"
      ]
    },
    "softwareTechnologies": [
      {
        "type": "APMNG",
        "edition": null,
        "version": null
      }
    ],
    "bitness": "64bit",
    "monitoringState": {
      "actualMonitoringState": "ON",
      "expectedMonitoringState": "ON",
      "restartRequired": false
    }
  }
]

Код ответа

200

Аноним

Поиск

GET все процессы

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

Ещё

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

Содержание

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

Параметры

Ответ

Коды ответов

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

Объект `ResponseBody`

Объект `ProcessGroupInstance`

Объект _ `TagInfo`

Объект _ `EntityShortRepresentation`

Объект _ `MonitoringState`

Объект _ `ProcessGroupInstanceModule`

Объект _ `AgentVersion`

Объект _ `TechnologyInfo`

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

Заголовки ответа

Пример

Завиток

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

Тело ответа

Код ответа

Навигация

Навигация

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

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

Аноним

Поиск

GET все процессы

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

Параметры

Ответ

Коды ответов

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

Объект ResponseBody

Объект ProcessGroupInstance

Объект _ TagInfo

Объект _ EntityShortRepresentation

Объект _ MonitoringState

Объект _ ProcessGroupInstanceModule

Объект _ AgentVersion

Объект _ TechnologyInfo

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

Заголовки ответа

Пример

Завиток

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

Тело ответа

Код ответа

Навигация

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

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

Объект `ResponseBody`

Объект `ProcessGroupInstance`

Объект _ `TagInfo`

Объект _ `EntityShortRepresentation`

Объект _ `MonitoringState`

Объект _ `ProcessGroupInstanceModule`

Объект _ `AgentVersion`

Объект _ `TechnologyInfo`