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

ENetrebin в 16:38, 2 февраля 2023

2023-02-02T16:38:36Z

← Предыдущая		Версия 16:38, 2 февраля 2023
Строка 1:		Строка 1:
	Получает список всех групп процессов в вашей среде ~~Ключ-АСТРОМ~~ вместе с их параметрами и взаимосвязями.		Получает список всех групп процессов в вашей среде Dynatrace вместе с их параметрами и взаимосвязями.

	Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.		Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Строка 87:		Строка 87:
	\|Фильтрует группы процессов по узлу, на котором они выполняются.		\|Фильтрует группы процессов по узлу, на котором они выполняются.

	Укажите ~~Ключ-АСТРОМ~~ ID интересующего вас хоста.		Укажите Dynatrace ID интересующего вас хоста.

	Для указания нескольких хостов используйте следующий формат: <code>host=hostID1&host=hostID2</code>.		Для указания нескольких хостов используйте следующий формат: <code>host=hostID1&host=hostID2</code>.
Строка 180:		Строка 180:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого объекта.		\|Идентификатор объекта Dynatrace требуемого объекта.
	\|-		\|-
	\|displayName		\|displayName
	\|string		\|string
	\|Имя объекта ~~Ключ-АСТРОМ~~, отображаемое в пользовательском интерфейсе.		\|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
	\|-		\|-
	\|customizedName		\|customizedName
Строка 240:		Строка 240:

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

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

Строка 667:		Строка 667:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Astromkey~~ entity",		"name": "Dynatrace entity",
	"description": "~~Astromkey~~ entity for the REST API example"		"description": "Dynatrace entity for the REST API example"
	}		}
	],		],
Строка 695:		Строка 695:
	==== Curl ====		==== Curl ====
	<code>curl -X GET \		<code>curl -X GET \
	'<nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v1/entity/infrastructure/process-groups?relativeTime=5mins'</nowiki> \		'<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups?relativeTime=5mins'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
	<code><nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v1/entity/infrastructure/process-groups?relativeTime=5mins</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups?relativeTime=5mins</nowiki></code>

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

ENetrebin: /* Параметры */

2022-10-13T09:39:20Z

Параметры

← Предыдущая		Версия 09:39, 13 октября 2022
Строка 80:		Строка 80:

	Чтобы указать несколько групп процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.		Чтобы указать несколько групп процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
	\|~~запрос~~		\|query
	\|по желанию		\|по желанию
	\|-		\|-
Строка 207:		Строка 207:
	\|-		\|-
	\|fromRelationships		\|fromRelationships
	\|~~объект~~		\|object
	\| -		\| -
	\|-		\|-
	\|toRelationships		\|toRelationships
	\|~~объект~~		\|object
	\| -		\| -
	\|-		\|-
	\|metadata		\|metadata
	\|~~объект~~		\|object
	\| -		\| -
	\|-		\|-

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

2022-10-13T09:37:38Z

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

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

ENetrebin: Новая страница: «Получает список всех групп процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и...»

2022-10-12T18:00:13Z

Новая страница: «Получает список всех групп процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и...»

Новая страница

Получает список всех групп процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и взаимосвязями.

Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.

Вы можете дополнительно ограничить вывод с помощью нумерации страниц:

# Укажите количество результатов на странице в параметре запроса pageSize .
# Затем используйте курсор из заголовка ответа Next-Page-Key в параметре запроса nextPageKey для получения последующих страниц.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups</nowiki></code>
|-
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups</nowiki></code>
|}

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

== Параметры ==
Срок ограничен максимальным периодом в 3 дня .
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|startTimestamp
|integer
|Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).

Если не задано, используется отставание на 72 часа.
|запрос
|по желанию
|-
|endTimestamp
|integer
|Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).

Если не задано, используется текущая метка времени.

Срок не должен превышать 3 дней.
|запрос
|по желанию
|-
|относительное время
|string
|Относительный период времени, начиная с настоящего времени.

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

* <code>min</code>
* <code>5mins</code>
* <code>10mins</code>
* <code>15mins</code>
* <code>30mins</code>
* <code>hour</code>
* <code>2hours</code>
* <code>6hours</code>
* <code>day</code>
* <code>3days</code>
|запрос
|по желанию
|-
|ярлык
|string []
|Фильтрует результирующий набор групп процессов по указанному тегу. Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Группа процессов должна соответствовать всем указанным тегам.

В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: <code>tag=[context]key:value</code>. Для пользовательских тегов "ключ-значение" не указывайте контекст: <code>tag=key:value</code>.
|запрос
|по желанию
|-
|организация
|string []
|Фильтры приводят только к указанным группам процессов.

Чтобы указать несколько групп процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
|запрос
|по желанию
|-
|хозяин
|string []
|Фильтрует группы процессов по узлу, на котором они выполняются.

Укажите Ключ-АСТРОМ ID интересующего вас хоста.

Для указания нескольких хостов используйте следующий формат: <code>host=hostID1&host=hostID2</code>.

Применяется логика ИЛИ .
|запрос
|по желанию
|-
|Зона управления
|integer
|Возвращайте только те группы процессов, которые входят в указанную зону управления.
|запрос
|по желанию
|-
|включитьДетали
|логический
|Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.

Исключение сведений может ускорить запросы.

Если не установлено, то <code>true</code>используется.
|запрос
|по желанию
|-
|размер страницы
|integer
|Количество групп процессов на странице результатов.

Если не задано, нумерация страниц не используется, и результат содержит все группы процессов, соответствующие заданным критериям фильтрации.
|запрос
|по желанию
|-
|ключ следующей страницы
|string
|Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа.

Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора.

Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.
|запрос
|по желанию
|}

== Заголовки ответа ==
{| class="wikitable"
!Заголовок
!Тип
!Описание
|-
|Общее количество
|integer
|Предполагаемое количество результатов.
|-
|Клавиша следующей страницы
|string
|Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
|-
|Размер страницы
|string
|Максимальное количество результатов на странице.
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Группа процессов []
|Успех
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}

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

==== Объект _ <code>ResponseBody</code> ====
Объект не предоставляет никаких параметров.

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

== Пример ==
В этом примере в запросе перечислены все группы процессов среды, обнаруженные за последние 5 минут .

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

Результат усекается до двух записей.

==== Завиток ====
<code>curl -X GET \
'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups?relativeTime=5mins'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/process-groups?relativeTime=5mins</nowiki></code>

==== Тело ответа ====
<code>[
{
"entityId": "PROCESS_GROUP-B34081EFF9E5F516",
"displayName": "Apache Web Server apache2",
"discoveredName": "Apache Web Server apache2",
"firstSeenTimestamp": 1405316247660,
"lastSeenTimestamp": 1545149212556,
"tags": [],
"fromRelationships": {},
"toRelationships": {
"runsOn": [
"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
}
]
},
{
"entityId": "PROCESS_GROUP-E5C3CC7EC1F80B5B",
"displayName": "PHP-FPM",
"discoveredName": "PHP-FPM",
"firstSeenTimestamp": 1503909407206,
"lastSeenTimestamp": 1545149349700,
"tags": [],
"fromRelationships": {
"runsOn": [
"HOST-74CDC8809AD43931",
"HOST-9A81EACCA0270218"
]
},
"toRelationships": {
"isInstanceOf": [
"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