IKuznetsov в 16:17, 2 января 2025

2025-01-02T16:17:31Z

← Предыдущая версия		Версия от 16:17, 2 января 2025
Строка 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%9E%D1%82%D1%81%D0%BB%D0%B5%D0%B6%D0%B8%D0%B2%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B%20v2 Отслеживаемые объекты v2] / GET объект'''''

	Получает полный список свойств указанной объекта. Фактический список зависит от типа объекта.		Получает полный список свойств указанной объекта. Фактический список зависит от типа объекта.

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

	== Пример ==		== Пример ==
Строка 295:		Строка 297:
	==== Curl ====		==== Curl ====
	<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

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

2024-12-26T09:36:04Z

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

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "HOST-06F288EE2A930951",		"entityId": "HOST-06F288EE2A930951",
	"type": "HOST",		"type": "HOST",
Строка 294:		Строка 294:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A'</nowiki> \		<curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

Строка 301:		Строка 301:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"entityId": "SERVICE-1125C375A187D27A",		"entityId": "SERVICE-1125C375A187D27A",
	"displayName": "dotNetBackend_easyTravel_x64",		"displayName": "dotNetBackend_easyTravel_x64",

ENetrebin: Новая страница: «Получает полный список свойств указанной объекта. Фактический список зависит от типа об...»

2022-10-14T09:34:18Z

Новая страница: «Получает полный список свойств указанной объекта. Фактический список зависит от типа об...»

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

Получает полный список свойств указанной объекта. Фактический список зависит от типа объекта.

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|entityId
|string
|Идентификатор требуемой объекта.
|дорожка
|требуется
|-
|from
|string
|Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не задано, используется относительный таймфрейм в три дня ( <code>now-3d</code>).
|запрос
|по желанию
|-
|to
|string
|Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|запрос
|по желанию
|-
|fields
|string
|Определяет список свойств объекта, включенных в ответ. Идентификатор и имя объекта всегда включаются в ответ.

Чтобы добавить свойства, перечислите их с начальным плюсом <code>+</code>. Вы можете указать несколько свойств, разделенных запятой (например, <code>fields=+lastSeenTms,+properties.BITNESS</code>).

Используйте запрос типа объекта GET, чтобы получить список свойств, доступных для вашего типа объекта. Поля из объекта свойств должны быть указаны в <code>properties.FIELD</code>формате (например, <code>properties.BITNESS</code>).
|запрос
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Entity
|Успех
|}

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

==== Объект <code>Entity</code> ====
Свойства контролируемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|firstSeenTms
|integer
|Отметка времени, когда объект был впервые замечен, в миллисекундах UTC.
|-
|lastSeenTms
|integer
|Временная метка последнего появления объекта в миллисекундах UTC.
|-
|fromRelationships
|объект
|Список отношений, в которых объект занимает позицию FROM.
|-
|toRelationships
|объект
|Список отношений, в которых объект занимает позицию TO.
|-
|tags
|METag[]
|Набор тегов, присвоенных объекту.
|-
|managementZones
|ManagementZone[]
|Набор зон управления, к которым принадлежит объект.
|-
|entityId
|string
|Идентификатор объекта.
|-
|icon
|EntityIcon
|Значок контролируемого объекта.
|-
|properties
|объект
|Список дополнительных свойств объекта.
|-
|type
|string
|Тип объекта.
|-
|displayName
|string
|Имя объекта, отображаемое в пользовательском интерфейсе.
|}

==== Объект <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор объекта.
|-
|type
|string
|Тип объекта.
|}

==== Объект <code>METag</code> ====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|stringRepresentation
|string
|Строковое представление тега.
|-
|value
|string
|Значение тега.
|-
|key
|string
|Ключ тега.
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

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

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

==== Объект _ <code>EntityIcon</code> ====
Значок контролируемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|primaryIconType
|string
|Основная иконка объекта.

Определяется идентификатором бариста значка.
|-
|customIconPath
|string
|Определяемый пользователем значок объекта.

Укажите идентификатор бариста значка или URL-адрес собственного значка.
|-
|secondaryIconType
|string
|Второстепенная иконка сущности.

Определяется идентификатором бариста значка.
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "HOST-06F288EE2A930951",
"type": "HOST",
"displayName": "my host",
"icon": {
"primaryIconType": "linux",
"secondaryIconType": "microsoft-azure-signet",
"customIconPath": "host"
},
"firstSeenTms": 1574697667547,
"lastSeenTms": 1588242361417,
"properties": {
"bitness": 64,
"monitoringMode": "FULL_STACK",
"osType": "LINUX",
"osArchitecture": "X86",
"networkZoneId": "aws.us.east01",
"cpuCores": 8
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "architecture",
"value": "x86",
"stringRepresentation": "architecture:x86"
},
{
"context": "ENVIRONMENT",
"key": "Infrastructure",
"value": "Linux",
"stringRepresentation": "[ENVIRONMENT]Infrastructure:Linux"
}
],
"managementZones": [
{
"id": "6239538939987181652",
"name": "main app"
}
],
"fromRelationships": {
"isInstanceOf": [
{
"id": "HOST_GROUP-0E489369D663A4BF",
"type": "HOST_GROUP"
}
]
},
"toRelationships": {
"isDiskOf": [
{
"id": "DISK-0393340DCA3853B0",
"type": "DISK"
}
]
}
}</code>

== Пример ==
В этом примере в запросе перечислены свойства службы dotNetBackend_easyTravel_x64 с идентификатором SERVICE-1125C375A187D27A .

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

==== Curl ====
<code>curl -L -X GET '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/SERVICE-1125C375A187D27A</nowiki></code>

==== Тело запроса ====
<code>{
"entityId": "SERVICE-1125C375A187D27A",
"displayName": "dotNetBackend_easyTravel_x64",
"firstSeenTms": 1424310498896,
"lastSeenTms": 1590609632865,
"properties": {
"serviceType": "WEB_REQUEST_SERVICE",
"internalName": "dotNetBackend_easyTravel_x64",
"webServerName": "dotNetBackend_easyTravel_x64",
"softwareTechnologies": [
{
"edition": "FullCLR",
"version": "2.0.50727"
},
{
"type": "DOTNET",
"edition": ".NET Framework",
"version": "3.5.1.0"
},
{
"type": "ADO_NET",
"edition": "System.Data",
"version": "2.0.50727.8751"
},
{
"type": "ASP_DOTNET",
"version": "3.5.1.0"
},
{
"type": "IIS_APP_POOL",
"version": "10.0.14393.0"
},
{
"type": "DOTNET_REMOTING",
"version": "2.0.50727.8771"
}
],
"serviceTechnologyTypes": [
"IIS app pool",
"ASP.NET",
"DotNet"
],
"mainServiceSoftwareTech": {
"type": "ASP_DOTNET"
},
"contextRoot": "/",
"agentTechnologyType": "DOTNET"
},
"tags": [
{
"context": "CONTEXTLESS",
"key": "customService",
"stringRepresentation": "customService"
},
{
"context": "CONTEXTLESS",
"key": "easytravel",
"value": "backend",
"stringRepresentation": "easytravel:backend"
}
],
"mangementZones": [
{
"id": "2827032493241090264",
"name": "allServices"
},
{
"id": "9130632296508575249",
"name": "Easytravel"
}
],
"fromRelationships": {
"calls": [
{
"id": "SERVICE-775060208AAA1058",
"type": "SERVICE"
},
{
"id": "SERVICE-6737CDED8F9BF969",
"type": "SERVICE"
}
],
"runsOn": [
{
"id": "PROCESS_GROUP-0A9A52EA262BC039",
"type": "PROCESS_GROUP"
}
],
"runsOnHost": [
{
"id": "HOST-B64B6B9CB11E2244",
"type": "HOST"
},
{
"id": "HOST-CF61BC45E6282234",
"type": "HOST"
}
],
"runsOnProcessGroupInstance": [
{
"id": "PROCESS_GROUP_INSTANCE-DE765F657721AF59",
"type": "PROCESS_GROUP_INSTANCE"
}
]
},
"toRelationships": {
"calls": [
{
"id": "SERVICE-D20E300A0A6814EF",
"type": "SERVICE"
},
{
"id": "SERVICE-7675DAA7464128F8",
"type": "SERVICE"
}
]
}
}</code>

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

GET объект - История изменений

IKuznetsov в 16:17, 2 января 2025

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

ENetrebin: Новая страница: «Получает полный список свойств указанной объекта. Фактический список зависит от типа об...»