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

2025-01-02T16:17:12Z

← Предыдущая версия		Версия от 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 все типы объектов'''''

	Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде.		Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде.

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

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

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

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

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

2024-12-26T09:22:31Z

← Предыдущая версия		Версия от 09:22, 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/v2/entityTypes</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/entityTypes</nowiki></code>
	\|-		\|-
Строка 192:		Строка 192:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"totalCount": 1,		"totalCount": 1,
	"pageSize": 1,		"pageSize": 1,
Строка 254:		Строка 254:

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

Строка 261:		Строка 261:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"totalCount": 33,		"totalCount": 33,
	"pageSize": 33,		"pageSize": 33,

ENetrebin: Новая страница: «Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде. Кроме того, для каж...»

2022-10-14T09:59:30Z

Новая страница: «Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде. Кроме того, для каж...»

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

Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде.

Кроме того, для каждого типа сущности перечислены возможные свойства сущности этого типа. Обратите внимание, что это заполнители, показывающие, какие свойства может иметь объект, а не фактические свойства. Чтобы просмотреть фактические свойства сущности, используйте запрос GET сущности .

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

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

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

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|query
|по желанию
|-
|pageSize
|integer
|Количество типов сущностей в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 50.
|query
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|EntityTypeList
|Успех
|-
|400
|
|Не удалось. Больше нет типов сущностей для экспорта.
|}

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

==== Объект <code>EntityTypeList</code> ====
Список свойств всех доступных типов сущностей.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|totalCount
|integer
|Общее количество записей в результате.
|-
|pageSize
|integer
|Количество записей на странице.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|types
|EntityType[]
|Список метаинформации для всех доступных типов объектов
|}

==== Объект <code>EntityType</code> ====
Список свойств отслеживаемого типа объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityLimitExceeded
|boolean
|Был ли превышен предел создания объекта для данного типа
|-
|fromRelationships
|ToPosition[]
|Список возможных взаимосвязей, в которых отслеживаемый тип объекта занимает позицию FROM.
|-
|toRelationships
|FromPosition[]
|Список возможных взаимосвязей, в которых отслеживаемый тип объекта занимает позицию TO.
|-
|tags
|string
|Заполнитель для списка тегов фактического объекта.
|-
|managementZones
|string
|Заполнитель для списка зон управления фактического объекта.
|-
|dimensionKey
|string
|Ключ измерения, используемый в метриках для этого отслеживаемого объекта.
|-
|properties
|EntityTypePropertyDto[]
|Список дополнительных свойств отслеживаемого типа объекта.
|-
|type
|string
|Тип отслеживаемого объекта.
|-
|displayName
|string
|Отображаемое имя отслеживаемого объекта.
|}

==== Объект <code>ToPosition</code> ====
Позиция TO отношения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|toTypes
|string []
|Список отслеживаемых типов объектов, которые могут занимать позицию TO.
|-
|id
|string
|Идентификатор отношения.
|}

==== Объект <code>FromPosition</code> ====
Позиция FROM отношения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|fromTypes
|string []
|Список отслеживаемых типов объектов, которые могут занимать позицию FROM.
|-
|id
|string
|Идентификатор отношения.
|}

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

=== JSON-модель тела ответа ===
<code>{
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"types": [
{
"type": "HOST",
"entityLimitExceeded": "false",
"properties": [
{
"id": "BITNESS",
"type": "Enum"
},
{
"id": "CPU_CORES",
"type": "Number"
}
],
"tags": "placeholder for tags",
"managementZones": "placeholder for management zones",
"fromRelationships": [
{
"id": "RUNS_ON_RESOURCE",
"toTypes": [
"CUSTOM_DEVICE"
]
},
{
"id": "IS_NETWORK_CLIENT_OF_HOST",
"toTypes": [
"HOST",
"CUSTOM_DEVICE"
]
}
],
"toRelationships": [
{
"id": "IS_DISK_OF",
"fromTypes": [
"DISK"
]
},
{
"id": "IS_SITE_OF",
"fromTypes": [
"VMWARE_DATACENTER",
"GEOLOC_SITE"
]
}
]
}
]
}</code>

== Пример ==
В этом примере в запросе перечислены все типы объектов, наблюдаемые в среде mySampleEnv .

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

Поскольку полный результат довольно длинный, он усечен до трех записей. Впоследствии массив свойств каждого объекта также усекается до трех записей.

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

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

==== Тело ответа ====
<code>{
"totalCount": 33,
"pageSize": 33,
"types": [
{
"type": "APPLICATION",
"properties": [
{
"id": "applicationType",
"type": "Enum"
},
{
"id": "conditionalName",
"type": "String"
},
{
"id": "customizedName",
"type": "String"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "calls",
"toTypes": [
"SERVICE"
]
}
],
"toRelationships": []
},
{
"type": "HOST",
"properties": [
{
"id": "ipAddresses",
"type": "List"
},
{
"id": "osType",
"type": "Enum"
},
{
"id": "osVersion",
"type": "String"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "runsOn",
"toTypes": [
"EC2_INSTANCE",
"VIRTUALMACHINE",
"AZURE_VM",
"OPENSTACK_VM",
"GOOGLE_COMPUTE_ENGINE",
"HYPERVISOR"
]
},
{
"id": "runsOnResource",
"toTypes": [
"CUSTOM_DEVICE"
]
},
{
"id": "isInstanceOf",
"toTypes": [
"HOST_GROUP"
]
},
{
"id": "isNetworkClientOfHost",
"toTypes": [
"HOST",
"CUSTOM_DEVICE"
]
},
{
"id": "candidateTalksWith",
"toTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
}
],
"toRelationships": [
{
"id": "isProcessOf",
"fromTypes": [
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "runsOn",
"fromTypes": [
"OPENSTACK_VM",
"PROCESS_GROUP"
]
},
{
"id": "isSiteOf",
"fromTypes": [
"GEOLOC_SITE",
"VMWARE_DATACENTER"
]
},
{
"id": "talksWithCandidate",
"fromTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "isNetworkClientOfHost",
"fromTypes": [
"CUSTOM_DEVICE",
"HOST"
]
},
{
"id": "isDiskOf",
"fromTypes": [
"DISK"
]
},
{
"id": "runsOnHost",
"fromTypes": [
"SERVICE"
]
},
{
"id": "isContainerGroupInstanceOfHost",
"fromTypes": [
"CONTAINER_GROUP_INSTANCE"
]
}
]
},
{
"type": "SERVICE",
"properties": [
{
"id": "mainServiceSoftwareTech",
"type": "Map"
},
{
"id": "port",
"type": "Number"
},
{
"id": "serviceType",
"type": "Enum"
}
],
"tags": "List",
"managementZones": "List",
"fromRelationships": [
{
"id": "runsOn",
"toTypes": [
"CUSTOM_DEVICE_GROUP",
"PROCESS_GROUP"
]
},
{
"id": "runsOnProcessGroupInstance",
"toTypes": [
"CUSTOM_DEVICE",
"PROCESS_GROUP_INSTANCE"
]
},
{
"id": "runsOnHost",
"toTypes": [
"CUSTOM_DEVICE",
"HOST"
]
},
{
"id": "calls",
"toTypes": [
"SERVICE"
]
}
],
"toRelationships": [
{
"id": "calls",
"fromTypes": [
"MOBILE_APPLICATION",
"CUSTOM_APPLICATION",
"HTTP_CHECK",
"APPLICATION",
"SERVICE"
]
}
]
}
]
}</code>

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

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

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

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

ENetrebin: Новая страница: «Список всех типов отслеживаемых объектов, наблюдаемых в вашей среде. Кроме того, для каж...»