GET все приложения - История изменений

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

2025-01-02T18:12:55Z

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

2024-12-29T12:33:43Z

← Предыдущая версия		Версия от 12:33, 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=%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,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Приложения] / GET все приложения'''''

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

IKuznetsov в 11:54, 29 декабря 2024

2024-12-29T11:54:21Z

← Предыдущая версия		Версия от 11:54, 29 декабря 2024
Строка 1:		Строка 1:
	Получает список всех приложений в вашей среде ~~Ключ-АСТРОМ~~ вместе с их параметрами.		Получает список всех приложений в вашей среде АппОптима вместе с их параметрами.

	Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.		Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Строка 166:		Строка 166:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого объекта.		\|Идентификатор объекта АппОптима требуемого объекта.
	\|-		\|-
	\|displayName		\|displayName
	\|string		\|string
	\|Имя объекта ~~Ключ-АСТРОМ~~, отображаемое в пользовательском интерфейсе.		\|Имя объекта АппОптима, отображаемое в пользовательском интерфейсе.
	\|-		\|-
	\|customizedName		\|customizedName
Строка 241:		Строка 241:

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

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

Строка 335:		Строка 335:
	"applicationType": "AGENTLESS_MONITORING"		"applicationType": "AGENTLESS_MONITORING"
	}		}
	]~~</code>~~		]

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

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

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

IKuznetsov в 10:33, 26 декабря 2024

2024-12-26T10:33:04Z

← Предыдущая версия		Версия от 10:33, 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/applications</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>
	\|-		\|-
Строка 298:		Строка 298:

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

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

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~[		<[
	{		{
	"entityId": "APPLICATION-EA7C4B59F27D43EB",		"entityId": "APPLICATION-EA7C4B59F27D43EB",

ENetrebin в 16:59, 12 октября 2022

2022-10-12T16:59:57Z

← Предыдущая версия		Версия от 16:59, 12 октября 2022
Строка 327:		Строка 327:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Dynatrace~~ entity",		"name": "Astromkey entity",
	"description": "~~Dynatrace~~ entity for the REST API example"		"description": "Astromkey entity for the REST API example"
	}		}
	],		],

ENetrebin в 14:42, 12 октября 2022

2022-10-12T14:42:19Z

← Предыдущая версия		Версия от 14:42, 12 октября 2022
Строка 14:		Строка 14:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>
	\|-		\|-
	\|~~Окружающая среда ActiveGate~~		\|Среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>
	\|}		\|}

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

2022-10-12T14:32:23Z

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

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

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

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

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

# Укажите количество результатов на странице в параметре запроса 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/applications</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications</nowiki></code>
|}

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

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

Если не задано, используется отставание на 72 часа.
|query
|по желанию
|-
|endTimestamp
|integer
|Отметка времени окончания запрошенного таймфрейма в миллисекундах (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
|integer
|Возвращает только те приложения, которые входят в указанную зону управления.
|query
|по желанию
|-
|includeDetails
|boolean
|Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.

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

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

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

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

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

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

== Ответ ==

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

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

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

==== Объект <code>Application</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
|-
|displayName
|string
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|-
|customizedName
|string
|Пользовательское имя объекта
|-
|discoveredName
|string
|Обнаруженное имя объекта
|-
|firstSeenTimestamp
|integer
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|-
|lastSeenTimestamp
|integer
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|-
|tags
|TagInfo[]
|Список тегов сущностей.
|-
|fromRelationships
|объект
|Список исходящих вызовов из приложения.
|-
|toRelationships
|объект
|Список входящих вызовов в приложение.
|-
|applicationMatchTarget
|string
| -
Элемент может содержать эти значения

* <code>DOMAIN</code>
* <code>URL</code>
|-
|managementZones
|EntityShortRepresentation[]
|Зоны управления, частью которых является объект.
|-
|ruleAppliedPattern
|string
| -
|-
|ruleAppliedMatchType
|string
| -
Элемент может содержать эти значения

* <code>ALL_URLS_AND_DOMAINS</code>
* <code>CONTAINS</code>
* <code>ENDS</code>
* <code>EQUALS</code>
* <code>MATCHES</code>
* <code>STARTS</code>
|-
|applicationType
|string
| -
Элемент может содержать эти значения

* <code>AGENTLESS_MONITORING</code>
* <code>AMP</code>
* <code>AUTO_INJECTED</code>
* <code>DEFAULT</code>
* <code>SAAS_VENDOR</code>
|}

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

=== JSON-модель тела ответа ===
<code>[
{
"entityId": "string",
"displayName": "string",
"customizedName": "string",
"discoveredName": "string",
"firstSeenTimestamp": 1,
"lastSeenTimestamp": 1,
"tags": [
{
"context": "AWS",
"key": "string",
"value": "string"
}
],
"fromRelationships": {
"calls": [
"string"
]
},
"toRelationships": {
"monitors": [
"string"
]
},
"applicationMatchTarget": "DOMAIN",
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}
],
"ruleAppliedPattern": "string",
"ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS",
"applicationType": "AGENTLESS_MONITORING"
}
]</code>

== Пример ==
В этом примере запрос запрашивает список всех приложений в среде.

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

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

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

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

==== Тело ответа ====
<code>[
{
"entityId": "APPLICATION-EA7C4B59F27D43EB",
"displayName": "RUM Default Application",
"customizedName": "RUM Default Application",
"discoveredName": "RUM Default Application",
"firstSeenTimestamp": 1422282024216,
"lastSeenTimestamp": 1538579528065,
"tags": [
{
"context": "CONTEXTLESS",
"key": "Mytag"
},
{
"context": "CONTEXTLESS",
"key": "Test"
}
],
"fromRelationships": {
"calls": [
"SERVICE-FFE4B7A6D72F2CAC"
]
},
"toRelationships": {},
"applicationType": "DEFAULT",
"ruleAppliedPattern": "http",
"managementZones": [
{
"id": "-6239538939987181652",
"name": "allTypes"
},
{
"id": "-2519468841583898843",
"name": "app name exists"
},
{
"id": "4485554873951847460",
"name": "Applications except easyTravel"
}
]
},
{
"entityId": "APPLICATION-BBFA55551D507E2B",
"displayName": "easyTravel Ionic Web",
"discoveredName": "easyTravel Ionic Web",
"firstSeenTimestamp": 1528695861873,
"lastSeenTimestamp": 1538572321269,
"tags": [],
"fromRelationships": {
"calls": [
"SERVICE-ED0B103392AC86BF"
]
},
"toRelationships": {},
"applicationType": "RUMONLY",
"managementZones": [
{
"id": "-6239538939987181652",
"name": "allTypes"
},
{
"id": "-4085081632192243904",
"name": "easyTravel"
}
]
},
{
"entityId": "MOBILE_APPLICATION-752C288D59734C79",
"displayName": "easyTravel Demo",
"customizedName": "easyTravel Demo",
"discoveredName": "752c288d-5973-4c79-b7d1-3a49d4d42ea0",
"firstSeenTimestamp": 1469613941393,
"lastSeenTimestamp": 1538654940201,
"tags": [
{
"context": "CONTEXTLESS",
"key": "portal"
},
{
"context": "CONTEXTLESS",
"key": "easyTravel"
}
],
"fromRelationships": {
"calls": [
"SERVICE-ED0B103392AC86BF"
]
},
"toRelationships": {},
"mobileOsFamily": [
"ANDROID",
"IOS",
"WINDOWS"
],
"managementZones": [
{
"id": "-4085081632192243904",
"name": "easyTravel"
}
]
}
]</code>

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