GET процесс: различия между версиями
ENetrebin (обсуждение | вклад)   (Новая страница: «Получает параметры указанного процесса .  Запрос создает <code>application/json</code>полезную нагру...»)  | 
			
(нет различий) 
 | 
Версия 17:43, 12 октября 2022
Получает параметры указанного процесса .
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}
 | 
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes/{meIdentifier}
 | 
Аутентификация
Чтобы выполнить  этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимый | 
|---|---|---|---|---|
| meIdentifier | string | Идентификатор объекта Ключ-АСТРОМ требуемого процесса. | дорожка | требуется | 
Ответ
Коды ответов
| Код | Тип | Описание | 
|---|---|---|
| 200 | Экземпляр группы процессов | Успех | 
Объекты тела ответа
Объект _ ProcessGroupInstance
Параметры процесса.
| Элемент | Тип | Описание | 
|---|---|---|
| идентификатор объекта | string | Идентификатор объекта Ключ-АСТРОМ требуемого объекта. | 
| показать имя | string | Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе. | 
| индивидуальное имя | string | Пользовательское имя объекта | 
| обнаружил имя | string | Обнаруженное имя объекта | 
| firstSeenTimestamp | integer | Отметка времени первого обнаружения объекта в миллисекундах UTC. | 
| lastSeenTimestamp | integer | Отметка времени последнего обнаружения объекта в миллисекундах UTC. | 
| теги | Информация о теге [] | Список тегов сущностей. | 
| отОтношения | объект | - | 
| кОтношения | объект | - | 
| метаданные | объект | - | 
| управлениеЗоны | Краткое представление объекта [] | Зоны управления, частью которых является объект. | 
| модули | string [] | - | 
| MonitoringState | Состояние мониторинга | Определяет текущее состояние мониторинга объекта. | 
| azureHostName | string | - | 
| azureSiteName | string | - | 
| listenPorts | целое [] | - | 
| версииedModules | Модуль экземпляра группы процессов [] | - | 
| агентВерсии | Версия агента [] | Версии OneAgents, которые в настоящее время работают на объекте. | 
| программное обеспечениеТехнологии | Информация о технологии [] | - | 
| битность | string | -
 Элемент может содержать эти значения 
  | 
Объект _ TagInfo
Тег сущности Ключ-АСТРОМ.
| Элемент | Тип | Описание | 
|---|---|---|
| контекст | string | Происхождение тега, например AWS или Cloud Foundry.
 Пользовательские теги используют это  Элемент может содержать эти значения 
  | 
| ключ | string | Ключ тега.
 Пользовательские теги имеют значение тега здесь.  | 
| ценность | string | Значение тега.
 Не применимо к пользовательским тегам.  | 
Объект _ EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
| Элемент | Тип | Описание | 
|---|---|---|
| я бы | string | Идентификатор объекта Ключ-АСТРОМ. | 
| имя | string | Имя объекта Ключ-АСТРОМ. | 
| описание | string | Краткое описание сущности Ключ-АСТРОМ. | 
Объект _ MonitoringState
Определяет текущее состояние мониторинга объекта.
| Элемент | Тип | Описание | 
|---|---|---|
| фактическое состояние мониторинга | string | Текущее фактическое состояние мониторинга объекта.
 Элемент может содержать эти значения 
  | 
| ожидаемое состояние мониторинга | string | Состояние мониторинга, ожидаемое от конфигурации
 Элемент может содержать эти значения 
  | 
| перезапускОбязательный | логический | Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг | 
Объект _ ProcessGroupInstanceModule
| Элемент | Тип | Описание | 
|---|---|---|
| имя | string | - | 
| версия | string | - | 
Объект _ AgentVersion
Определяет версию агента, работающего в данный момент на объекте.
| Элемент | Тип | Описание | 
|---|---|---|
| главный | integer | Номер основной версии. | 
| незначительный | integer | Младший номер версии. | 
| ревизия | integer | Номер ревизии. | 
| отметка времени | 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"
}
Пример
В этом примере запрос получает сведения о процессе apache2 веб-сервера Apache с идентификатором PROCESS_GROUP_INSTANCE-EC9688429EB24B6B .
Маркер API передается в заголовке авторизации .
Завиток
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