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

Текущая версия от 18:29, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Топология / Процессы / GET процесс

Получает параметры указанного процесса .

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}`

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
meIdentifier	string	Идентификатор объекта АппОптима требуемого процесса.	Path	требуется

Ответ

Коды ответов

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

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

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

Тег сущности АппОптима.

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

Объект `TechnologyInfo`

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

Объект `ProcessGroupInstanceModule`

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

Объект `EntityShortRepresentation`

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

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

Объект `AgentVersion`

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

Элемент	Тип	Описание
major	integer	Номер основной версии.
minor	integer	Младший номер версии.
revision	integer	Номер ревизии.
timestamp	string	string временной метки: формат "ггггммдд-ччммсс
sourceRevision	string	Строковое представление номера версии SVN.

Объект `MonitoringState`

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

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

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"
    ],
    "AppOptimaNodeIds": [
      "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"
    ],
    "AppOptimaClusterIds": [
      "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": "AppOptima entity",
      "description": "AppOptima 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"
}

Пример

В этом примере запрос получает сведения о процессе apache2 веб-сервера Apache с идентификатором PROCESS_GROUP_INSTANCE-EC9688429EB24B6B .

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

Curl

<curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B

Тело ответа

<{
  "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
  "displayName": "Apache Web Server apache2",
  "discoveredName": "Apache Web Server apache2",
  "firstSeenTimestamp": 1464951001104,
  "lastSeenTimestamp": 1545147232609,
  "tags": [],
  "fromRelationships": {
    "isProcessOf": [
      "HOST-5FD609AD6757BE7D"
    ],
    "isInstanceOf": [
      "PROCESS_GROUP-B34081EFF9E5F516"
    ]
  },
  "toRelationships": {
    "runsOnProcessGroupInstance": [
      "SERVICE-C3173FEB08025322",
      "SERVICE-443EACA6DCAEE651",
      "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": [
    80,
    443
  ],
  "bitness": "64bit",
  "modules": [
    "mod_auth_basic.c",
    "mod_authn_file.c",
    "mod_negotiation.c",
    "mod_dir.c",
    "mod_rewrite.c"
  ],
  "monitoringState": {
    "actualMonitoringState": "ON",
    "expectedMonitoringState": "ON",
    "restartRequired": false
  },
  "agentVersions": [
    {
      "major": 1,
      "minor": 157,
      "revision": 210,
      "timestamp": "20181213-075558",
      "sourceRevision": ""
    }
  ]
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%95%D0%B4%D0%B8%D0%BD%D1%8B%D0%B9%D0%90%D0%B3%D0%B5%D0%BD%D1%82%20%D0%BD%D0%B0%20%D1%85%D0%BE%D1%81%D1%82%D0%B5-,%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F,-%D0%9F%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Топология] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D1%8D%D0%B3%D0%B0-,%D0%9F%D1%80%D0%BE%D1%86%D0%B5%D1%81%D1%81%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BF%D1%80%D0%BE%D1%86%D0%B5%D1%81%D1%81%D1%8B Процессы] / GET процесс'''''
 Получает параметры указанного процесса .
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}</nowiki></code>
 |-
@@ Строка 24: / Строка 26: @@
 |meIdentifier
 |string
-|Идентификатор объекта Ключ-АСТРОМ требуемого процесса.
+|Идентификатор объекта АппОптима требуемого процесса.
 |Path
 |требуется
@@ Строка 52: / Строка 54: @@
 |-
 |entityId
-|нить
+|string
-|Идентификатор объекта Dynatrace требуемого объекта.
+|Идентификатор объекта АппОптима требуемого объекта.
 |-
 |displayName
-|нить
+|string
-|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
+|Имя объекта АппОптима, отображаемое в пользовательском интерфейсе.
 |-
 |customizedName
-|нить
+|string
 |Пользовательское имя объекта
 |-
 |discoveredName
-|нить
+|string
 |Обнаруженное имя объекта
 |-
 |firstSeenTimestamp
-|целое число
+|integer
 |Отметка времени первого обнаружения объекта в миллисекундах UTC.
 |-
 |lastSeenTimestamp
-|целое число
+|integer
 |Отметка времени последнего обнаружения объекта в миллисекундах UTC.
 |-
@@ Строка 96: / Строка 98: @@
 |-
 |azureSiteName
-|нить
+|string
 | -
 |-
@@ Строка 108: / Строка 110: @@
 |-
 |modules
-|строка []
+|string []
 | -
 |-
@@ Строка 116: / Строка 118: @@
 |-
 |listenPorts
-|целое []
+|integer []
 | -
 |-
 |bitness
-|нить
+|string
 | -
 Элемент может содержать эти значения
@@ Строка 128: / Строка 130: @@
 |-
 |azureHostName
-|нить
+|string
 | -
 |-
@@ Строка 137: / Строка 139: @@
 ==== Объект <code>TagInfo</code> ====
-Тег сущности Ключ-АСТРОМ.
+Тег сущности АппОптима.
 {| class="wikitable"
 !Элемент
@@ Строка 180: / Строка 182: @@
 |-
 |type
-|нить
+|string
 | -
 |-
 |edition
-|нить
+|string
 | -
 |-
 |version
-|нить
+|string
 | -
 |}
@@ Строка 199: / Строка 201: @@
 |-
 |name
-|нить
+|string
 | -
 |-
 |version
-|нить
+|string
 | -
 |}
 ==== Объект <code>EntityShortRepresentation</code> ====
-Краткое представление объекта Dynatrace.
+Краткое представление объекта АппОптима.
 {| class="wikitable"
 !Элемент
@@ Строка 215: / Строка 217: @@
 |-
 |id
-|нить
+|string
-|Идентификатор объекта Dynatrace.
+|Идентификатор объекта АппОптима.
 |-
 |name
-|нить
+|string
-|Имя объекта Dynatrace.
+|Имя объекта АппОптима.
 |-
 |description
-|нить
+|string
-|Краткое описание сущности Dynatrace.
+|Краткое описание сущности АппОптима.
 |}
@@ Строка 235: / Строка 237: @@
 |-
 |major
-|целое число
+|integer
 |Номер основной версии.
 |-
 |minor
-|целое число
+|integer
 |Младший номер версии.
 |-
 |revision
-|целое число
+|integer
 |Номер ревизии.
 |-
 |timestamp
-|нить
+|string
-|Строка временной метки: формат "ггггммдд-ччммсс
+|string временной метки: формат "ггггммдд-ччммсс
 |-
 |sourceRevision
-|нить
+|string
 |Строковое представление номера версии SVN.
 |}
@@ Строка 263: / Строка 265: @@
 |-
 |actualMonitoringState
-|нить
+|string
 |Текущее фактическое состояние мониторинга объекта.
@@ Строка 272: / Строка 274: @@
 |-
 |expectedMonitoringState
-|нить
+|string
 |Состояние мониторинга, ожидаемое от конфигурации
@@ Строка 286: / Строка 288: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "entityId": "string",
     "displayName": "string",
@@ Строка 326: / Строка 328: @@
         "string"
       ],
-      "AstromkeyNodeIds": [
+      "AppOptimaNodeIds": [
         "string"
       ],
@@ Строка 592: / Строка 594: @@
         "string"
       ],
-      "AstromkeyClusterIds": [
+      "AppOptimaClusterIds": [
         "string"
       ],
@@ Строка 636: / Строка 638: @@
       {
         "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
-        "name": "Astromkey entity",
+        "name": "AppOptima entity",
-        "description": "Astromkey entity for the REST API example"
+        "description": "AppOptima entity for the REST API example"
       }
     ],
@@ Строка 676: / Строка 678: @@
     ],
     "bitness": "32bit"
-  }</code>
+  }
 == Пример ==
@@ Строка 684: / Строка 686: @@
 ==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 692: / Строка 694: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
     "displayName": "Apache Web Server apache2",
@@ Строка 771: / Строка 773: @@
       }
     ]
-  }</code>
+  }
 ==== Код ответа ====