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

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

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
meIdentifier	string	Идентификатор объекта Ключ-АСТРОМ требуемой группы процессов.	path	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	ProcessGroup	Успех

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

Объект `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"
    }
  ]
}

Пример

В этом примере запрос получает сведения о группе процессов PHP-FPM с идентификатором PROCESS_GROUP-E5C3CC7EC1F80B5B .

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

Curl

curl -X GET \
  'https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B

Тело ответа

{
  "entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
  "displayName": "PHP-FPM",
  "discoveredName": "PHP-FPM",
  "firstSeenTimestamp": 1503909407206,
  "lastSeenTimestamp": 1545150389821,
  "tags": [],
  "fromRelationships": {
    "isNetworkClientOfProcessGroup": [
      "PROCESS_GROUP-49C926A7091830E3"
    ],
    "runsOn": [
      "HOST-249385B2CEBFE51F",
      "HOST-890A0495CB619DDF",
      "HOST-3FBF48320E4079EF"
    ]
  },
  "toRelationships": {
    "isInstanceOf": [
      "PROCESS_GROUP_INSTANCE-BBFBABB27B2686F2",
      "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

@@ Строка 10: / Строка 10: @@
 == Аутентификация ==
-Чтобы выполsнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 17: / Строка 17: @@
 !Тип
 !Описание
-!В
+!In
-!Необходимый
+!Необходимость
 |-
 |meIdentifier
 |string
 |Идентификатор объекта Ключ-АСТРОМ требуемой группы процессов.
-|дорожка
+|path
 |требуется
 |}
@@ Строка 36: / Строка 36: @@
 |-
 |200
-|Группа процессов
+|ProcessGroup
 |Успех
 |}
@@ Строка 42: / Строка 42: @@
 === Объекты тела ответа ===
-==== Объект _ <code>ProcessGroup</code> ====
+==== Объект <code>ProcessGroup</code> ====
 Параметры группы процессов.
 {| class="wikitable"
@@ Строка 49: / Строка 49: @@
 !Описание
 |-
-|идентификатор объекта
+|entityId
 |string
 |Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
 |-
-|показать имя
+|displayName
 |string
 |Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
 |-
-|индивидуальное имя
+|customizedName
 |string
 |Пользовательское имя объекта
 |-
-|обнаружил имя
+|discoveredName
 |string
 |Обнаруженное имя объекта
@@ Строка 73: / Строка 73: @@
 |Отметка времени последнего обнаружения объекта в миллисекундах UTC.
 |-
-|теги
+|tags
-|Информация о теге []
+|TagInfo[]
 |Список тегов сущностей.
 |-
-|отОтношения
+|fromRelationships
-|объект
+|object
 | -
 |-
-|кОтношения
+|toRelationships
-|объект
+|object
 | -
 |-
-|метаданные
+|metadata
-|объект
+|object
 | -
 |-
-|управлениеЗоны
+|softwareTechnologies
-|Краткое представление объекта []
+|TechnologyInfo[]
-|Зоны управления, частью которых является объект.
-|-
-|azureHostName
-|string
 | -
 |-
@@ Строка 100: / Строка 96: @@
 |string
 | -
+|-
+|managementZones
+|EntityShortRepresentation[]
+|Зоны управления, частью которых является объект.
 |-
 |listenPorts
-|целое []
+|integer []
 | -
 |-
-|программное обеспечениеТехнологии
+|azureHostName
-|Информация о технологии []
+|string
 | -
 |}
-==== Объект _ <code>TagInfo</code> ====
+==== Объект <code>TagInfo</code> ====
 Тег сущности Ключ-АСТРОМ.
 {| class="wikitable"
@@ Строка 117: / Строка 117: @@
 !Описание
 |-
-|контекст
+|context
 |string
 |Происхождение тега, например AWS или Cloud Foundry.
@@ Строка 134: / Строка 134: @@
 * <code>KUBERNETES</code>
 |-
-|ключ
+|key
 |string
 |Ключ тега.
@@ Строка 140: / Строка 140: @@
 Пользовательские теги имеют значение тега здесь.
 |-
-|ценность
+|value
 |string
 |Значение тега.
@@ Строка 154: / Строка 154: @@
 !Описание
 |-
-|я бы
+|id
 |string
 |Идентификатор объекта Ключ-АСТРОМ.
 |-
-|имя
+|name
 |string
 |Имя объекта Ключ-АСТРОМ.
 |-
-|описание
+|description
 |string
 |Краткое описание сущности Ключ-АСТРОМ.
 |}
-==== Объект _ <code>TechnologyInfo</code> ====
+==== Объект <code>TechnologyInfo</code> ====
 {| class="wikitable"
 !Элемент
@@ Строка 173: / Строка 173: @@
 !Описание
 |-
-|тип
+|type
 |string
 | -
 |-
-|версия
+|edition
 |string
 | -
 |-
-|версия
+|version
 |string
 | -
@@ Строка 560: / Строка 560: @@
 Маркер API передается в заголовке авторизации .
-==== Завиток ====
+==== Curl ====
   <code>curl -X GET \
     '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B'</nowiki> \