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

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

2025-01-02T18:14:45Z

← Предыдущая версия		Версия от 18:14, 2 января 2025
Строка 482:		Строка 482:
	{		{
	"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:48, 29 декабря 2024

2024-12-29T12:48:32Z

← Предыдущая версия		Версия от 12:48, 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 Развёртывание] / [[API АппОптима#:~:text%3D%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-%2C%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F%2C-%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=POST%20%D1%82%D1%8D%D0%B3%D0%BE%D0%B2-,%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B Сервисы] / GET все сервисы'''''

	Получает список всех служб в вашей среде АппОптима вместе с их параметрами и взаимосвязями.		Получает список всех служб в вашей среде АппОптима вместе с их параметрами и взаимосвязями.

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

2024-12-26T09:40:03Z

← Предыдущая версия		Версия от 09:40, 26 декабря 2024
Строка 1:		Строка 1:
	Получает список всех служб в вашей среде ~~Ключ-Астром~~ вместе с их параметрами и взаимосвязями.		Получает список всех служб в вашей среде АппОптима вместе с их параметрами и взаимосвязями.

	Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.		Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Строка 507:		Строка 507:
	"databaseVendor": "string"		"databaseVendor": "string"
	}		}
	]~~</code>~~		]

	== Пример ==		== Пример ==
Строка 519:		Строка 519:
	<curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

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

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

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

2024-12-26T09:39:48Z

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

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

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>
Строка 525:		Строка 525:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~[		<[
	{		{
	"entityId": "SERVICE-72503CBDD2AEF066",		"entityId": "SERVICE-72503CBDD2AEF066",

ENetrebin: Новая страница: «Получает список всех служб в вашей среде Ключ-Астром вместе с их параметрами и взаимосвя...»

2022-10-13T11:13:47Z

Новая страница: «Получает список всех служб в вашей среде Ключ-Астром вместе с их параметрами и взаимосвя...»

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

Получает список всех служб в вашей среде Ключ-Астром вместе с их параметрами и взаимосвязями.

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

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

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

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

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

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

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

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

Срок не должен превышать 3 дней.
|query
|по желанию
|-
|relativeTime
|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>
|query
|по желанию
|-
|tag
|string []
|Фильтрует результирующий набор сервисов по указанному тегу. Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Сервис должен соответствовать всем указанным тегам.

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

Чтобы указать несколько сервисов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
|query
|по желанию
|-
|managementZone
|string
|Возвращайте только те службы, которые входят в указанную зону управления.
|query
|по желанию
|-
|includeDetails
|boolean
|Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.

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

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

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

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

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

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

== Ответ ==

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

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

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

==== Объект <code>Service</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта string требуемого объекта.
|-
|displayName
|string
|Имя объекта string, отображаемое в пользовательском интерфейсе.
|-
|customizedName
|string
|Пользовательское имя объекта
|-
|discoveredName
|string
|Обнаруженное имя объекта
|-
|firstSeenTimestamp
|string
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|-
|lastSeenTimestamp
|string
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|-
|tags
|TagInfo[]
|Список тегов сущностей.
|-
|fromRelationships
|объект
| -
|-
|toRelationships
|объект
| -
|-
|path
|string
| -
|-
|webServerName
|string
| -
|-
|ibmCtgServerName
|string
|Имя шлюза транзакций IBM CICS.
|-
|akkaActorSystem
|string
|Услуги актерской системы akka.
|-
|contextRoot
|string
| -
|-
|port
|string
| -
|-
|ibmCtgGatewayUrl
|string
|URL-адрес шлюза IBM CTG.
|-
|databaseName
|string
| -
|-
|ipAddresses
|string []
| -
|-
|webServiceName
|string
| -
|-
|className
|string
| -
|-
|webApplicationId
|string
| -
|-
|managementZones
|EntityShortRepresentation[]
|Зоны управления, частью которых является объект.
|-
|agentTechnologyType
|string
| -
Элемент может содержать эти значения

* <code>APACHE</code>
* <code>DOTNET</code>
* <code>DUMPPROC</code>
* <code>GO</code>
* <code>IIS</code>
* <code>JAVA</code>
* <code>LOG_ANALYTICS</code>
* <code>N/A</code>
* <code>NET</code>
* <code>NETTRACER</code>
* <code>NGINX</code>
* <code>NODEJS</code>
* <code>OPENTRACINGNATIVE</code>
* <code>OS</code>
* <code>PHP</code>
* <code>PLUGIN</code>
* <code>PROCESS</code>
* <code>PYTHON</code>
* <code>REMOTE_PLUGIN</code>
* <code>RUBY</code>
* <code>SDK</code>
* <code>UPDATER</code>
* <code>VARNISH</code>
* <code>WSMB</code>
* <code>Z</code>
|-
|remoteEndpoint
|string
|Конечная точка удаленной службы.
|-
|softwareTechnologies
|TechnologyInfo[]
| -
|-
|webServiceNamespace
|string
| -
|-
|remoteServiceName
|string
|Имя удаленной службы.
|-
|serviceTechnologyTypes
|string []
| -
|-
|databaseHostNames
|string []
| -
|-
|esbApplicationName
|string
|Имя приложения ESB.
|-
|serviceType
|string
| -
Элемент может содержать эти значения

* <code>AMP</code>
* <code>Cics</code>
* <code>CicsInteraction</code>
* <code>CustomApplication</code>
* <code>Database</code>
* <code>EnterpriseServiceBus</code>
* <code>External</code>
* <code>Ims</code>
* <code>ImsInteraction</code>
* <code>Messaging</code>
* <code>Method</code>
* <code>Mobile</code>
* <code>Process</code>
* <code>QueueInteraction</code>
* <code>QueueListener</code>
* <code>RemoteCall</code>
* <code>Rmi</code>
* <code>SaasVendor</code>
* <code>Span</code>
* <code>Unknown</code>
* <code>WebRequest</code>
* <code>WebService</code>
* <code>WebSite</code>
* <code>ZosConnect</code>
|-
|iibApplicationName
|string
|Имя приложения IIB.
|-
|isExternalService
|boolean
| -
|-
|databaseVendor
|string
| -
|}

==== Объект <code>TagInfo</code> ====
Тег сущности string.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|context
|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>
|-
|key
|string
|Ключ тега.

Пользовательские теги имеют значение тега здесь.
|-
|value
|string
|Значение тега.

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

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

==== Объект <code>TechnologyInfo</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
| -
|-
|edition
|string
| -
|-
|version
|string
| -
|}

=== JSON-модель тела ответа ===
<code>[
{
"entityId": "string",
"displayName": "string",
"customizedName": "string",
"discoveredName": "string",
"firstSeenTimestamp": 1,
"lastSeenTimestamp": 1,
"tags": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"fromRelationships": {
"runsOnProcessGroupInstance": [
"string"
],
"calls": [
"string"
],
"runsOn": [
"string"
]
},
"toRelationships": {
"calls": [
"string"
]
},
"path": "string",
"webServerName": "string",
"ibmCtgServerName": "string",
"akkaActorSystem": "string",
"contextRoot": "string",
"port": 1,
"ibmCtgGatewayUrl": "string",
"databaseName": "string",
"ipAddresses": [
"string"
],
"webServiceName": "string",
"className": "string",
"webApplicationId": "string",
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity",
"description": "Astromkey entity for the REST API example"
}
],
"agentTechnologyType": "APACHE",
"remoteEndpoint": "string",
"softwareTechnologies": [
{
"type": "string",
"edition": "string",
"version": "string"
}
],
"webServiceNamespace": "string",
"remoteServiceName": "string",
"serviceTechnologyTypes": [
"string"
],
"databaseHostNames": [
"string"
],
"esbApplicationName": "string",
"serviceType": "AMP",
"iibApplicationName": "string",
"isExternalService": true,
"databaseVendor": "string"
}
]</code>

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

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

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

==== Curl ====
<code>curl -X GET \
'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>

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

==== Тело ответа ====
<code>[
{
"entityId": "SERVICE-72503CBDD2AEF066",
"displayName": "PHP-FPM via domain socket /run/php7-fpm.sock",
"discoveredName": "PHP-FPM via domain socket /run/php7-fpm.sock",
"firstSeenTimestamp": 1505902015554,
"lastSeenTimestamp": 1544025169570,
"tags": [
{
"context": "CONTEXTLESS",
"key": "Sample tag"
}
],
"fromRelationships": {
"runsOnProcessGroupInstance": [
"PROCESS_GROUP_INSTANCE-165E2E1655782C30",
"PROCESS_GROUP_INSTANCE-2E41AD6095ACE67B",
"PROCESS_GROUP_INSTANCE-3E537F0F455E9757"
],
"runsOn": [
"PROCESS_GROUP-E5C3CC7EC1F80B5B"
]
},
"toRelationships": {
"calls": [
"SERVICE-5304CCF4AFBFF35E"
]
},
"agentTechnologyType": "N/A",
"serviceType": "WebRequest",
"softwareTechnologies": [
{
"type": "SQLITE",
"edition": null,
"version": null
},
{
"type": "PHP",
"edition": "FPM",
"version": "7.0.32"
},
{
"type": "PHP_FPM",
"edition": null,
"version": null
}
]
},
{
"entityId": "SERVICE-52AC624D70C377BC",
"displayName": "Requests to public networks",
"discoveredName": "Requests to public networks",
"firstSeenTimestamp": 1421376505750,
"lastSeenTimestamp": 1544025153570,
"tags": [],
"fromRelationships": {},
"toRelationships": {
"calls": [
"SERVICE-635F6C4CAD07BC56",
"SERVICE-74C7ACD74FA27688",
"SERVICE-C7790E5EDD1F895E"
]
},
"agentTechnologyType": "N/A",
"serviceType": "WebRequest"
}
]</code>

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