GET группы процессов - История изменений

IKuznetsov в 18:21, 2 января 2025

2025-01-02T18:21:16Z

← Предыдущая версия		Версия от 18:21, 2 января 2025
Строка 229:		Строка 229:
	"string"		"string"
	],		],
	"~~AstromkeyNodeIds~~": [		"AppOptimaNodeIds": [
	"string"		"string"
	],		],
Строка 495:		Строка 495:
	"string"		"string"
	],		],
	"~~AstromkeyClusterIds~~": [		"AppOptimaClusterIds": [
	"string"		"string"
	],		],
Строка 539:		Строка 539:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"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"
	}		}
	],		],

IKuznetsov в 12:44, 29 декабря 2024

2024-12-29T12:44:14Z

← Предыдущая версия		Версия от 12:44, 29 декабря 2024
Строка 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=GET%20%D0%BF%D1%80%D0%BE%D1%86%D0%B5%D1%81%D1%81-,%D0%93%D1%80%D1%83%D0%BF%D0%BF%D1%8B%20%D0%BF%D1%80%D0%BE%D1%86%D0%B5%D1%81%D1%81%D0%BE%D0%B2,-GET%20%D0%B2%D1%81%D0%B5%20%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B Группы процессов] / GET группы процессов'''''

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.
	{\| class="wikitable"		{\| class="wikitable"

IKuznetsov в 14:11, 26 декабря 2024

2024-12-26T14:11:03Z

← Предыдущая версия		Версия от 14:11, 26 декабря 2024
Строка 22:		Строка 22:
	\|meIdentifier		\|meIdentifier
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемой группы процессов.		\|Идентификатор объекта АппОптима требуемой группы процессов.
	\|path		\|path
	\|требуется		\|требуется
Строка 51:		Строка 51:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого объекта.		\|Идентификатор объекта АппОптима требуемого объекта.
	\|-		\|-
	\|displayName		\|displayName
	\|string		\|string
	\|Имя объекта ~~Ключ-АСТРОМ~~, отображаемое в пользовательском интерфейсе.		\|Имя объекта АппОптима, отображаемое в пользовательском интерфейсе.
	\|-		\|-
	\|customizedName		\|customizedName
Строка 111:		Строка 111:

	==== Объект <code>TagInfo</code> ====		==== Объект <code>TagInfo</code> ====
	Тег сущности ~~Ключ-АСТРОМ~~.		Тег сущности АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 148:		Строка 148:

	==== Объект _ <code>EntityShortRepresentation</code> ====		==== Объект _ <code>EntityShortRepresentation</code> ====
	Краткое представление объекта ~~Ключ-АСТРОМ~~.		Краткое представление объекта АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 156:		Строка 156:
	\|id		\|id
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~.		\|Идентификатор объекта АппОптима.
	\|-		\|-
	\|name		\|name
	\|string		\|string
	\|Имя объекта ~~Ключ-АСТРОМ~~.		\|Имя объекта АппОптима.
	\|-		\|-
	\|description		\|description
	\|string		\|string
	\|Краткое описание сущности ~~Ключ-АСТРОМ~~.		\|Краткое описание сущности АппОптима.
	\|}		\|}

Строка 553:		Строка 553:
	}		}
	]		]
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 563:		Строка 563:
	<curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/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' \

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 629:		Строка 629:
	}		}
	]		]
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	200		200

IKuznetsov в 09:19, 26 декабря 2024

2024-12-26T09:19:10Z

← Предыдущая версия		Версия от 09:19, 26 декабря 2024
Строка 2:		Строка 2:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}</nowiki></code>
	\|-		\|-
Строка 187:		Строка 187:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"displayName": "string",		"displayName": "string",
Строка 561:		Строка 561:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/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>
Строка 569:		Строка 569:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",		"entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
	"displayName": "PHP-FPM",		"displayName": "PHP-FPM",

ENetrebin: /* Аутентификация */

2022-10-13T09:51:30Z

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

Внесённые изменения

ENetrebin: Новая страница: «Запрос создает `application/json`полезную нагрузку. {| class="wikitable" | rowspan="2" |GET |Managed |`https:...»`


2022-10-12T18:06:10Z
Новая страница: «Запрос создает <code>application/json</code>полезную нагрузку. {| class="wikitable" | rowspan="2" |GET |Managed |<code><nowiki>https:...»
Новая страница
Запрос создает <code>application/json</code>полезную нагрузку.

{| class="wikitable"

| rowspan="2" |GET

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}</nowiki></code>

|-

|Cреда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{meIdentifier}</nowiki></code>

|}



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

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



== Параметры ==

{| class="wikitable"

!Параметр

!Тип

!Описание

!В

!Необходимый

|-

|meIdentifier

|string

|Идентификатор объекта Ключ-АСТРОМ требуемой группы процессов.

|дорожка

|требуется

|}



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

|Группа процессов

|Успех

|}



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



==== Объект _ <code>ProcessGroup</code> ====

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

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|идентификатор объекта

|string

|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.

|-

|показать имя

|string

|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.

|-

|индивидуальное имя

|string

|Пользовательское имя объекта

|-

|обнаружил имя

|string

|Обнаруженное имя объекта

|-

|firstSeenTimestamp

|integer

|Отметка времени первого обнаружения объекта в миллисекундах UTC.

|-

|lastSeenTimestamp

|integer

|Отметка времени последнего обнаружения объекта в миллисекундах UTC.

|-

|теги

|Информация о теге []

|Список тегов сущностей.

|-

|отОтношения

|объект

| -

|-

|кОтношения

|объект

| -

|-

|метаданные

|объект

| -

|-

|управлениеЗоны

|Краткое представление объекта []

|Зоны управления, частью которых является объект.

|-

|azureHostName

|string

| -

|-

|azureSiteName

|string

| -

|-

|listenPorts

|целое []

| -

|-

|программное обеспечениеТехнологии

|Информация о технологии []

| -

|}



==== Объект _ <code>TagInfo</code> ====

Тег сущности Ключ-АСТРОМ.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|контекст

|string

|Происхождение тега, например AWS или Cloud Foundry.



Пользовательские теги используют это <code>CONTEXTLESS</code>значение.



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



* <code>AWS</code>

* <code>AWS_GENERIC</code>

* <code>AZURE</code>

* <code>CLOUD_FOUNDRY</code>

* <code>CONTEXTLESS</code>

* <code>ENVIRONMENT</code>

* <code>GOOGLE_CLOUD</code>

* <code>KUBERNETES</code>

|-

|ключ

|string

|Ключ тега.



Пользовательские теги имеют значение тега здесь.

|-

|ценность

|string

|Значение тега.



Не применимо к пользовательским тегам.

|}



==== Объект _ <code>EntityShortRepresentation</code> ====

Краткое представление объекта Ключ-АСТРОМ.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|я бы

|string

|Идентификатор объекта Ключ-АСТРОМ.

|-

|имя

|string

|Имя объекта Ключ-АСТРОМ.

|-

|описание

|string

|Краткое описание сущности Ключ-АСТРОМ.

|}



==== Объект _ <code>TechnologyInfo</code> ====

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|тип

|string

| -

|-

|версия

|string

| -

|-

|версия

|string

| -

|}



=== JSON-модель тела ответа ===

 <code>{

   "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"

     }

   ]

 }</code>



== Пример ==

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



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



==== Завиток ====

 <code>curl -X GET \

   '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E5C3CC7EC1F80B5B'</nowiki> \

   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>



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

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



==== Тело ответа ====

 <code>{

   "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

     }

   ]

 }</code>



==== Код ответа ====

200

GET группы процессов - История изменений

IKuznetsov в 18:21, 2 января 2025

IKuznetsov в 12:44, 29 декабря 2024

IKuznetsov в 14:11, 26 декабря 2024

IKuznetsov в 09:19, 26 декабря 2024

ENetrebin: /* Аутентификация */

ENetrebin: Новая страница: «Запрос создает application/jsonполезную нагрузку. {| class="wikitable" | rowspan="2" |GET |Managed |https:...»

ENetrebin: Новая страница: «Запрос создает `application/json`полезную нагрузку. {| class="wikitable" | rowspan="2" |GET |Managed |`https:...»`