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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает параметры указанного процесса . Запрос создает <code>application/json</code>полезную нагру...»)
 
Строка 12: Строка 12:


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить  этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить  этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 19: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|meIdentifier
|meIdentifier
|string
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого процесса.
|Идентификатор объекта Ключ-АСТРОМ требуемого процесса.
|дорожка
|Path
|требуется
|требуется
|}
|}
Строка 38: Строка 38:
|-
|-
|200
|200
|Экземпляр группы процессов
|ProcessGroupInstance
|Успех
|Успех
|}
|}
Строка 44: Строка 44:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>ProcessGroupInstance</code> ====
==== Объект <code>ProcessGroupInstance</code> ====
Параметры процесса.
Параметры процесса.
{| class="wikitable"
{| class="wikitable"
Строка 51: Строка 51:
!Описание
!Описание
|-
|-
|идентификатор объекта
|entityId
|string
|нить
|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
|Идентификатор объекта Dynatrace требуемого объекта.
|-
|-
|показать имя
|displayName
|string
|нить
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
|-
|-
|индивидуальное имя
|customizedName
|string
|нить
|Пользовательское имя объекта
|Пользовательское имя объекта
|-
|-
|обнаружил имя
|discoveredName
|string
|нить
|Обнаруженное имя объекта
|Обнаруженное имя объекта
|-
|-
|firstSeenTimestamp
|firstSeenTimestamp
|integer
|целое число
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|-
|-
|lastSeenTimestamp
|lastSeenTimestamp
|integer
|целое число
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|-
|-
|теги
|tags
|Информация о теге []
|TagInfo[]
|Список тегов сущностей.
|Список тегов сущностей.
|-
|-
|отОтношения
|fromRelationships
|объект
|объект
| -
| -
|-
|-
|кОтношения
|toRelationships
|объект
|объект
| -
| -
|-
|-
|метаданные
|metadata
|объект
|объект
| -
| -
|-
|-
|управлениеЗоны
|softwareTechnologies
|Краткое представление объекта []
|TechnologyInfo[]
|Зоны управления, частью которых является объект.
|-
|модули
|string []
| -
| -
|-
|-
|MonitoringState
|azureSiteName
|Состояние мониторинга
|нить
|Определяет текущее состояние мониторинга объекта.
|-
|azureHostName
|string
| -
| -
|-
|-
|azureSiteName
|versionedModules
|string
|ProcessGroupInstanceModule[]
| -
| -
|-
|-
|listenPorts
|managementZones
|целое []
|EntityShortRepresentation[]
| -
|Зоны управления, частью которых является объект.
|-
|-
|версииedModules
|modules
|Модуль экземпляра группы процессов []
|строка []
| -
| -
|-
|-
|агентВерсии
|agentVersions
|Версия агента []
|AgentVersion[]
|Версии OneAgents, которые в настоящее время работают на объекте.
|Версии ЕдиногоАгента, которые в настоящее время работают на объекте.
|-
|-
|программное обеспечениеТехнологии
|listenPorts
|Информация о технологии []
|целое []
| -
| -
|-
|-
|битность
|bitness
|string
|нить
| -
| -
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 134: Строка 126:
* <code>32bit</code>
* <code>32bit</code>
* <code>64bit</code>
* <code>64bit</code>
|-
|azureHostName
|нить
| -
|-
|monitoringState
|MonitoringState
|Определяет текущее состояние мониторинга объекта.
|}
|}


==== Объект _ <code>TagInfo</code> ====
==== Объект <code>TagInfo</code> ====
Тег сущности Ключ-АСТРОМ.
Тег сущности Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
Строка 143: Строка 143:
!Описание
!Описание
|-
|-
|контекст
|context
|string
|string
|Происхождение тега, например AWS или Cloud Foundry.
|Происхождение тега, например AWS или Cloud Foundry.
Строка 160: Строка 160:
* <code>KUBERNETES</code>
* <code>KUBERNETES</code>
|-
|-
|ключ
|key
|string
|string
|Ключ тега.
|Ключ тега.
Строка 166: Строка 166:
Пользовательские теги имеют значение тега здесь.
Пользовательские теги имеют значение тега здесь.
|-
|-
|ценность
|value
|string
|string
|Значение тега.
|Значение тега.
Строка 173: Строка 173:
|}
|}


==== Объект _ <code>EntityShortRepresentation</code> ====
==== Объект <code>TechnologyInfo</code> ====
Краткое представление объекта Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 180: Строка 179:
!Описание
!Описание
|-
|-
|я бы
|type
|string
|нить
|Идентификатор объекта Ключ-АСТРОМ.
| -
|-
|-
|имя
|edition
|string
|нить
|Имя объекта Ключ-АСТРОМ.
| -
|-
|-
|описание
|version
|string
|нить
|Краткое описание сущности Ключ-АСТРОМ.
| -
|}
|}


==== Объект _ <code>MonitoringState</code> ====
==== Объект <code>ProcessGroupInstanceModule</code> ====
Определяет текущее состояние мониторинга объекта.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 200: Строка 198:
!Описание
!Описание
|-
|-
|фактическое состояние мониторинга
|name
|string
|нить
|Текущее фактическое состояние мониторинга объекта.
| -
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|ожидаемое состояние мониторинга
|version
|string
|нить
|Состояние мониторинга, ожидаемое от конфигурации
| -
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|перезапускОбязательный
|логический
|Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг
|}
|}


==== Объект _ <code>ProcessGroupInstanceModule</code> ====
==== Объект <code>EntityShortRepresentation</code> ====
Краткое представление объекта Dynatrace.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 229: Строка 214:
!Описание
!Описание
|-
|-
|имя
|id
|string
|нить
| -
|Идентификатор объекта Dynatrace.
|-
|name
|нить
|Имя объекта Dynatrace.
|-
|-
|версия
|description
|string
|нить
| -
|Краткое описание сущности Dynatrace.
|}
|}


==== Объект _ <code>AgentVersion</code> ====
==== Объект <code>AgentVersion</code> ====
Определяет версию агента, работающего в данный момент на объекте.
Определяет версию агента, работающего в данный момент на объекте.
{| class="wikitable"
{| class="wikitable"
Строка 245: Строка 234:
!Описание
!Описание
|-
|-
|главный
|major
|integer
|целое число
|Номер основной версии.
|Номер основной версии.
|-
|-
|незначительный
|minor
|integer
|целое число
|Младший номер версии.
|Младший номер версии.
|-
|-
|ревизия
|revision
|integer
|целое число
|Номер ревизии.
|Номер ревизии.
|-
|-
|отметка времени
|timestamp
|string
|нить
|Строка временной метки: формат "ггггммдд-ччммсс
|Строка временной метки: формат "ггггммдд-ччммсс
|-
|-
|Исходная версия
|sourceRevision
|string
|нить
|Строковое представление номера версии SVN.
|Строковое представление номера версии SVN.
|}
|}


==== Объект _ <code>TechnologyInfo</code> ====
==== Объект <code>MonitoringState</code> ====
Определяет текущее состояние мониторинга объекта.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 272: Строка 262:
!Описание
!Описание
|-
|-
|тип
|actualMonitoringState
|string
|нить
| -
|Текущее фактическое состояние мониторинга объекта.
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|версия
|expectedMonitoringState
|string
|нить
| -
|Состояние мониторинга, ожидаемое от конфигурации
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|версия
|restartRequired
|string
|boolean
| -
|Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг
|}
|}


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


==== Завиток ====
==== Curl ====
  <code>curl -X GET \
  <code>curl -X GET \
   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B</nowiki> \
   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes/PROCESS_GROUP_INSTANCE-EC9688429EB24B6B</nowiki> \

Версия 09:13, 13 октября 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) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

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

Ответ

Коды ответов

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

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

Объект ProcessGroupInstance

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

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

Элемент может содержать эти значения

  • 32bit
  • 64bit
azureHostName нить -
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 нить -
edition нить -
version нить -

Объект ProcessGroupInstanceModule

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

Объект EntityShortRepresentation

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

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

Объект AgentVersion

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

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

Объект MonitoringState

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

Элемент Тип Описание
actualMonitoringState нить Текущее фактическое состояние мониторинга объекта.

Элемент может содержать эти значения

  • OFF
  • ON
expectedMonitoringState нить Состояние мониторинга, ожидаемое от конфигурации

Элемент может содержать эти значения

  • 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"
    ],
    "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

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