GET группы процессов: различия между версиями
Материал из Dynatrace
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
Строка 22: | Строка 22: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта Dynatrace требуемой группы процессов. | ||
|path | |path | ||
|требуется | |требуется | ||
Строка 51: | Строка 51: | ||
|entityId | |entityId | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта Dynatrace требуемого объекта. | ||
|- | |- | ||
|displayName | |displayName | ||
|string | |string | ||
|Имя объекта | |Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе. | ||
|- | |- | ||
|customizedName | |customizedName | ||
Строка 111: | Строка 111: | ||
==== Объект <code>TagInfo</code> ==== | ==== Объект <code>TagInfo</code> ==== | ||
Тег сущности | Тег сущности Dynatrace. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 148: | Строка 148: | ||
==== Объект _ <code>EntityShortRepresentation</code> ==== | ==== Объект _ <code>EntityShortRepresentation</code> ==== | ||
Краткое представление объекта | Краткое представление объекта Dynatrace. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 156: | Строка 156: | ||
|id | |id | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта Dynatrace. | ||
|- | |- | ||
|name | |name | ||
|string | |string | ||
|Имя объекта | |Имя объекта Dynatrace. | ||
|- | |- | ||
|description | |description | ||
|string | |string | ||
|Краткое описание сущности | |Краткое описание сущности Dynatrace. | ||
|} | |} | ||
Строка 493: | Строка 493: | ||
"string" | "string" | ||
], | ], | ||
" | "DynatraceClusterIds": [ | ||
"string" | "string" | ||
], | ], | ||
Строка 537: | Строка 537: | ||
{ | { | ||
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", | ||
"name": " | "name": "Dynatrace entity", | ||
"description": " | "description": "Dynatrace entity for the REST API example" | ||
} | } | ||
], | ], | ||
Строка 562: | Строка 562: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl -X GET \ | <code>curl -X GET \ | ||
'<nowiki>https://mySampleEnv.live. | '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B'</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code> | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B</nowiki></code> | ||
==== Тело ответа ==== | ==== Тело ответа ==== |
Текущая версия на 16:45, 2 февраля 2023
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
meIdentifier | string | Идентификатор объекта Dynatrace требуемой группы процессов. | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | ProcessGroup | Успех |
Объекты тела ответа
Объект ProcessGroup
Параметры группы процессов.
Элемент | Тип | Описание |
---|---|---|
entityId | string | Идентификатор объекта Dynatrace требуемого объекта. |
displayName | string | Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе. |
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
Тег сущности Dynatrace.
Элемент | Тип | Описание |
---|---|---|
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
value | string | Значение тега.
Не применимо к пользовательским тегам. |
Объект _ EntityShortRepresentation
Краткое представление объекта Dynatrace.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта Dynatrace. |
name | string | Имя объекта Dynatrace. |
description | string | Краткое описание сущности Dynatrace. |
Объект 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"
],
"DynatraceClusterIds": [
"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": "Dynatrace entity",
"description": "Dynatrace 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.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/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