GET все группы процессов: различия между версиями

Версия от 09:39, 13 октября 2022

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

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

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

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

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

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

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

Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( 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	по желанию
host	string []	Фильтрует группы процессов по узлу, на котором они выполняются. Укажите Ключ-АСТРОМ ID интересующего вас хоста. Для указания нескольких хостов используйте следующий формат: `host=hostID1&host=hostID2`. Применяется логика OR .	query	по желанию
managementZone	integer	Возвращайте только те группы процессов, которые входят в указанную зону управления.	query	по желанию
includeDetails	boolean	Включает ( `true`) или исключает ( `false`) детали, которые запрашиваются у связанных объектов. Исключение сведений может ускорить запросы. Если не установлено, то `true`используется.	query	по желанию
pageSize	integer	Количество групп процессов на странице результатов. Если не задано, нумерация страниц не используется, и результат содержит все группы процессов, соответствующие заданным критериям фильтрации.	query	по желанию
nextPageKey	string	Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа. Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора. Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.	query	по желанию

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

Заголовок	Тип	Описание
Total-Count	integer	Предполагаемое количество результатов.
Next-Page-Key	string	Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
Page-Size	string	Максимальное количество результатов на странице.

Ответ

Коды ответов

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

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

Объект `ResponseBody`

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

Объект `ProcessGroup`

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

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

Объект `TagInfo`

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

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

Объект `EntityShortRepresentation`

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

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

Объект `TechnologyInfo`

Элемент	Тип	Описание
type	string	-
edition	string	-
version	string	-

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

[
  {
    "entityId": "string",
    "displayName": "string",
    "customizedName": "string",
    "discoveredName": "string",
    "firstSeenTimestamp": 1,
    "lastSeenTimestamp": 1,
    "tags": [
      {
        "context": "AWS",
        "key": "string",
        "value": "string"
      }
    ],
    "fromRelationships": {
      "isNetworkClientOfProcessGroup": [
        "string"
      ],
      "runsOn": [
        "string"
      ]
    },
    "toRelationships": {
      "isNetworkClientOfProcessGroup": [
        "string"
      ],
      "isInstanceOf": [
        "string"
      ],
      "runsOn": [
        "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"
      }
    ],
    "azureHostName": "string",
    "azureSiteName": "string",
    "listenPorts": [
      1
    ],
    "softwareTechnologies": [
      {
        "type": "string",
        "edition": "string",
        "version": "string"
      }
    ]
  }
]

Пример

В этом примере в запросе перечислены все группы процессов среды, обнаруженные за последние 5 минут .

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

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

Curl

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

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

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

Тело ответа

[
  {
    "entityId": "PROCESS_GROUP-B34081EFF9E5F516",
    "displayName": "Apache Web Server apache2",
    "discoveredName": "Apache Web Server apache2",
    "firstSeenTimestamp": 1405316247660,
    "lastSeenTimestamp": 1545149212556,
    "tags": [],
    "fromRelationships": {},
    "toRelationships": {
      "runsOn": [
        "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
      }
    ]
  },
  {
    "entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
    "displayName": "PHP-FPM",
    "discoveredName": "PHP-FPM",
    "firstSeenTimestamp": 1503909407206,
    "lastSeenTimestamp": 1545149349700,
    "tags": [],
    "fromRelationships": {
      "runsOn": [
        "HOST-74CDC8809AD43931",
        "HOST-9A81EACCA0270218"
      ]
    },
    "toRelationships": {
      "isInstanceOf": [
        "PROCESS_GROUP_INSTANCE-7E988C3503AE8803"
      ],
      "isNetworkClientOfProcessGroup": [
        "PROCESS_GROUP-49C926A7091830E3"
      ],
      "runsOn": [
        "SERVICE-72503CBDD2AEF066"
      ]
    },
    "metadata": {
      "hostGroups": [
        "authoring"
      ],
      "commandLineArgs": [
        "/usr/sbin/php-fpm7.0 --nodaemonize --fpm-config /etc/php/7.0/fpm/php-fpm.conf"
      ],
      "executables": [
        "php-fpm7.0"
      ],
      "executablePaths": [
        "/usr/sbin/php-fpm7.0"
      ]
    },
    "softwareTechnologies": [
      {
        "type": "SQLITE",
        "edition": null,
        "version": null
      },
      {
        "type": "PHP",
        "edition": "FPM",
        "version": "7.0.32"
      },
      {
        "type": "PHP_FPM",
        "edition": null,
        "version": null
      }
    ]
  }
]

Код ответа

200

@@ Строка 80: / Строка 80: @@
 Чтобы указать несколько групп процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
-|запрос
+|query
 |по желанию
 |-
@@ Строка 207: / Строка 207: @@
 |-
 |fromRelationships
-|объект
+|object
 | -
 |-
 |toRelationships
-|объект
+|object
 | -
 |-
 |metadata
-|объект
+|object
 | -
 |-