Создание пользовательского устройства - История изменений

ENetrebin в 14:37, 3 февраля 2023

2023-02-03T14:37:50Z

← Предыдущая		Версия 14:37, 3 февраля 2023
Строка 1:		Строка 1:
	Конечная точка пользовательского устройства API топологии и Smartscape позволяет создать пользовательское устройство с указанным именем в вашей среде ~~Ключ-АСТРОМ~~.		Конечная точка пользовательского устройства API топологии и Smartscape позволяет создать пользовательское устройство с указанным именем в вашей среде Dynatrace.

	На этой странице описывается, как создать пользовательское устройство без отправки на него каких-либо данных.		На этой странице описывается, как создать пользовательское устройство без отправки на него каких-либо данных.
Строка 33:		Строка 33:
	Если вы используете идентификатор существующего устройства, соответствующие параметры будут обновлены.		Если вы используете идентификатор существующего устройства, соответствующие параметры будут обновлены.

	Не используйте здесь идентификатор объекта ~~Ключ-АСТРОМ~~.		Не используйте здесь идентификатор объекта Dynatrace.
	\|path		\|path
	\|требуется		\|требуется
Строка 65:		Строка 65:
	Идентификатор группы помогает сохранить непротиворечивую картину отношений между группами устройств. Одним из многих случаев, когда важна правильная группа, является обнаружение службы: вы можете определить, какие пользовательские устройства должны вести к одной и той же службе, определив для них одинаковый идентификатор группы.		Идентификатор группы помогает сохранить непротиворечивую картину отношений между группами устройств. Одним из многих случаев, когда важна правильная группа, является обнаружение службы: вы можете определить, какие пользовательские устройства должны вести к одной и той же службе, определив для них одинаковый идентификатор группы.

	Если вы установите идентификатор группы, он будет хэширован в идентификатор объекта ~~Ключ-АСТРОМ~~ пользовательского устройства. В этом случае пользовательское устройство может быть частью только одной пользовательской группы устройств.		Если вы установите идентификатор группы, он будет хэширован в идентификатор объекта Dynatrace пользовательского устройства. В этом случае пользовательское устройство может быть частью только одной пользовательской группы устройств.

	Если вы не укажете идентификатор группы, ~~Ключ-АСТРОМ~~ создаст ее на основе идентификатора или типа пользовательского устройства. Кроме того, группа не будет хеширована в идентификатор устройства, что означает, что устройство может переключаться между группами.		Если вы не укажете идентификатор группы, Dynatrace создаст ее на основе идентификатора или типа пользовательского устройства. Кроме того, группа не будет хеширована в идентификатор устройства, что означает, что устройство может переключаться между группами.
	\|по желанию		\|по желанию
	\|-		\|-
Строка 131:		Строка 131:
	\|Список значений метрик, о которых сообщается для пользовательского устройства.		\|Список значений метрик, о которых сообщается для пользовательского устройства.

	Метрика, о которой вы сообщаете, уже должна существовать в ~~Ключ-АСТРОМ~~. Чтобы узнать, как создать пользовательскую метрику, см. статью Timeseries API v1 — ВСТАВКА пользовательской метрики .		Метрика, о которой вы сообщаете, уже должна существовать в Dynatrace. Чтобы узнать, как создать пользовательскую метрику, см. статью Timeseries API v1 — ВСТАВКА пользовательской метрики .

	~~Ключ-АСТРОМ~~ объединяет все значения, которые вы сообщаете для пользовательского устройства.		Dynatrace объединяет все значения, которые вы сообщаете для пользовательского устройства.

	Если вы отправите значение (включая пустое значение), оно будет добавлено к набору существующих значений.		Если вы отправите значение (включая пустое значение), оно будет добавлено к набору существующих значений.
Строка 198:		Строка 198:
	],		],
	"favicon": "<nowiki>https://www.freefavicon.com/freefavicons/food/cup-of-coffee-152-78475.png</nowiki>",		"favicon": "<nowiki>https://www.freefavicon.com/freefavicons/food/cup-of-coffee-152-78475.png</nowiki>",
	"configUrl": "<nowiki>http://coffee-machine.~~ruscomtech~~.internal.com/coffeemachine/manage</nowiki>",		"configUrl": "<nowiki>http://coffee-machine.dynatrace.internal.com/coffeemachine/manage</nowiki>",
	"type": "coffee machine",		"type": "coffee machine",
	"properties": {},		"properties": {},
Строка 219:		Строка 219:
	],		],
	"hostNames": [		"hostNames": [
	"coffee-machine.~~ruscomtech~~.internal.com"		"coffee-machine.dynatrace.internal.com"
	]		]
	}</code>		}</code>
Строка 251:		Строка 251:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ пользовательского устройства.		\|Идентификатор объекта Dynatrace пользовательского устройства.
	\|-		\|-
	\|groupId		\|groupId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ пользовательской группы устройств.		\|Идентификатор объекта Dynatrace пользовательской группы устройств.
	\|}		\|}

Строка 267:		Строка 267:
	В этом примере запрос создает пользовательское устройство <code>idOfmyCustomDevice</code>типа <code>F5-Firewall</code>, с IP-адресом <code>172.16.115.211</code>и портом прослушивания <code>9999</code>. В запросе также указываются некоторые дополнительные параметры.		В этом примере запрос создает пользовательское устройство <code>idOfmyCustomDevice</code>типа <code>F5-Firewall</code>, с IP-адресом <code>172.16.115.211</code>и портом прослушивания <code>9999</code>. В запросе также указываются некоторые дополнительные параметры.

	См. раздел Отчет о метрике пользовательского устройства через API ~~Ключ-АСТРОМ~~, чтобы узнать, как отправлять данные на вновь созданное пользовательское устройство.		См. раздел Отчет о метрике пользовательского устройства через API Dynatrace, чтобы узнать, как отправлять данные на вновь созданное пользовательское устройство.

	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
Строка 277:		Строка 277:
	==== Curl ====		==== Curl ====
	<code>curl -X POST \		<code>curl -X POST \
	<nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v1/entity/infrastructure/custom/idOfmyCustomDevice</nowiki> \		<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/custom/idOfmyCustomDevice</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
	-H 'Content-Type: application/json' \		-H 'Content-Type: application/json' \
	-d '{		-d '{
	"displayName" : "F5 Firewall 24",		"displayName"a: "F5 Firewall 24",
	"ipAddresses" : ["172.16.115.211"],		"ipAddresses"s: ["172.16.115.211"],
	"listenPorts" : ["9999"],		"listenPorts"P: ["9999"],
	"type" : "F5-Firewall",		"type" : "F5-Firewall",
	"favicon" : "<nowiki>http://assets.~~ruscomtech~~.ru/global/icons/f5.png</nowiki>",		"favicon"f: "<nowiki>http://assets.dynatrace.com/global/icons/f5.png</nowiki>",
	"configUrl" : "<nowiki>http://192.128.0.1:8080</nowiki>",		"configUrl" : ""<nowiki>http://192.128.0.1:8080</nowiki>",
	"tags": [		"tags": [
	"REST example"		"REST example"
	],		],
	"properties" : {		"properties"i: {
	"Sample Property 1": "Sample value 1"		"Sample Property 1": "Sample value 1"
	}		}
Строка 296:		Строка 296:

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
	<code><nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v1/entity/infrastructure/custom/idOfmyCustomDevice</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/custom/idOfmyCustomDevice</nowiki></code>

	==== Тело запроса ====		==== Тело запроса ====
Строка 304:		Строка 304:
	"listenPorts": ["9999"],		"listenPorts": ["9999"],
	"type": "F5-Firewall",		"type": "F5-Firewall",
	"favicon": "<nowiki>http://assets.~~ruscomtech~~.ru/global/icons/f5.png</nowiki>",		"favicon": "<nowiki>http://assets.dynatrace.com/global/icons/f5.png</nowiki>",
	"configUrl": ""<nowiki>http://192.128.0.1:8080</nowiki>",		"configUrl": """<nowiki>http://192.128.0.1:8080</nowiki>",
	"tags": ["REST example"],		"tags": ["REST example"],
	"properties": {		"properties": {

ENetrebin: /* Результат */

2022-10-13T13:39:04Z

Результат

← Предыдущая		Версия 13:39, 13 октября 2022
Строка 323:		Строка 323:
	==== Результат ====		==== Результат ====

			[[Файл:custom-device-smartscape.png]]
	[[Файл:Custom-device-658-bb2295e42c.png]]		[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin: /* Результат */

2022-10-13T13:35:42Z

Результат

← Предыдущая		Версия 13:35, 13 октября 2022
Строка 323:		Строка 323:
	==== Результат ====		==== Результат ====

	~~<nowiki>[[Custom-device-smartscape-1103-ba9b69e490.png]]</nowiki>~~
	[[Файл:Custom-device-658-bb2295e42c.png]]		[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin: /* Результат */

2022-10-13T13:34:01Z

Результат

← Предыдущая		Версия 13:34, 13 октября 2022
Строка 323:		Строка 323:
	==== Результат ====		==== Результат ====

			<nowiki>[[Custom-device-smartscape-1103-ba9b69e490.png]]</nowiki>
	[[Файл:Custom-device-658-bb2295e42c.png]]		[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin в 13:32, 13 октября 2022

2022-10-13T13:32:35Z

← Предыдущая		Версия 13:32, 13 октября 2022
Строка 323:		Строка 323:
	==== Результат ====		==== Результат ====

	~~[[Custom-device-658-bb2295e42c.png]]~~
	[[Файл:Custom-device-658-bb2295e42c.png]]		[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin: /* Результат */

2022-10-13T13:30:23Z

Результат

← Предыдущая		Версия 13:30, 13 октября 2022
Строка 323:		Строка 323:
	==== Результат ====		==== Результат ====

			[[Custom-device-658-bb2295e42c.png]]
	[[Файл:Custom-device-658-bb2295e42c.png]]		[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin: /* Результат */

2022-10-13T13:27:31Z

Результат

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

	==== Результат ====		==== Результат ====
	[[Файл:~~custom~~-device-~~smartscape~~-~~1103-ba9b69e490~~.png]]

			[[Файл:Custom-device-658-bb2295e42c.png]]

ENetrebin: /* Результат */

2022-10-13T13:20:28Z

Результат

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

	==== Результат ====		==== Результат ====
			[[Файл:custom-device-smartscape-1103-ba9b69e490.png]]

ENetrebin в 13:11, 13 октября 2022

2022-10-13T13:11:14Z

← Предыдущая		Версия 13:11, 13 октября 2022
Строка 11:		Строка 11:
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>
	\|-		\|-
	\|~~Окружающая среда ActiveGate~~		\|Среда АктивногоШлюза
	\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>		\|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>
	\|}		\|}
Строка 24:		Строка 24:
	!Тип		!Тип
	!Описание		!Описание
	!В		!In
	!Необходимость		!Необходимость
	\|-		\|-
Строка 55:		Строка 55:
	\|-		\|-
	\|displayName		\|displayName
	\|~~нить~~		\|string
	\|Имя пользовательского устройства, которое будет отображаться в пользовательском интерфейсе.		\|Имя пользовательского устройства, которое будет отображаться в пользовательском интерфейсе.
	\|по желанию		\|по желанию
	\|-		\|-
	\|group		\|group
	\|~~нить~~		\|string
	\|Определяемый пользователем идентификатор группы объекта.		\|Определяемый пользователем идентификатор группы объекта.

Строка 71:		Строка 71:
	\|-		\|-
	\|ipAddresses		\|ipAddresses
	\|~~строка~~ []		\|string []
	\|Список IP-адресов, принадлежащих пользовательскому устройству.		\|Список IP-адресов, принадлежащих пользовательскому устройству.

Строка 82:		Строка 82:
	\|-		\|-
	\|listenPorts		\|listenPorts
	\|~~целое~~ []		\|integer []
	\|Список портов, которые прослушиваются пользовательскими устройствами.		\|Список портов, которые прослушиваются пользовательскими устройствами.

Строка 97:		Строка 97:
	\|-		\|-
	\|type		\|type
	\|~~нить~~		\|string
	\|Определение типа технологии пользовательского устройства.		\|Определение типа технологии пользовательского устройства.

Строка 108:		Строка 108:
	\|-		\|-
	\|favicon		\|favicon
	\|~~нить~~		\|string
	\|Значок, который будет отображаться для вашего пользовательского компонента в Smartscape. Укажите полный URL-адрес файла значка.		\|Значок, который будет отображаться для вашего пользовательского компонента в Smartscape. Укажите полный URL-адрес файла значка.
	\|по желанию		\|по желанию
	\|-		\|-
	\|configUrl		\|configUrl
	\|~~нить~~		\|string
	\|URL-адрес веб-страницы конфигурации пользовательского устройства, например страницы входа в брандмауэр или маршрутизатор.		\|URL-адрес веб-страницы конфигурации пользовательского устройства, например страницы входа в брандмауэр или маршрутизатор.
	\|по желанию		\|по желанию
Строка 123:		Строка 123:
	\|-		\|-
	\|tags		\|tags
	\|~~строка~~ []		\|string []
	\|Список пользовательских тегов, которые вы хотите прикрепить к своему пользовательскому устройству.		\|Список пользовательских тегов, которые вы хотите прикрепить к своему пользовательскому устройству.
	\|по желанию		\|по желанию
Строка 141:		Строка 141:
	\|-		\|-
	\|hostNames		\|hostNames
	\|~~строка~~ []		\|string []
	\|Список имен хостов, связанных с пользовательским устройством.		\|Список имен хостов, связанных с пользовательским устройством.

Строка 161:		Строка 161:
	\|-		\|-
	\|timeseriesId		\|timeseriesId
	\|~~нить~~		\|string
	\|Идентификатор метрики, в которую вы хотите опубликовать точки данных.		\|Идентификатор метрики, в которую вы хотите опубликовать точки данных.
	\|требуется		\|требуется
Строка 242:		Строка 242:
	=== Объекты тела ответа ===		=== Объекты тела ответа ===

	==== Объект _ <code>CustomDevicePushResult</code> ====		==== Объект <code>CustomDevicePushResult</code> ====
	Результат пользовательского push-запроса устройства. Идентификатор объекта рассчитывается автоматически.		Результат пользовательского push-запроса устройства. Идентификатор объекта рассчитывается автоматически.
	{\| class="wikitable"		{\| class="wikitable"
Строка 250:		Строка 250:
	\|-		\|-
	\|entityId		\|entityId
	\|~~нить~~		\|string
	\|Идентификатор объекта Ключ-АСТРОМ пользовательского устройства.		\|Идентификатор объекта Ключ-АСТРОМ пользовательского устройства.
	\|-		\|-
	\|groupId		\|groupId
	\|~~нить~~		\|string
	\|Идентификатор объекта Ключ-АСТРОМ пользовательской группы устройств.		\|Идентификатор объекта Ключ-АСТРОМ пользовательской группы устройств.
	\|}		\|}
Строка 304:		Строка 304:
	"listenPorts": ["9999"],		"listenPorts": ["9999"],
	"type": "F5-Firewall",		"type": "F5-Firewall",
	"favicon": "http://assets.ruscomtech.ru~~<nowiki/>~~/global/icons/f5.png",		"favicon": "<nowiki>http://assets.ruscomtech.ru/global/icons/f5.png</nowiki>",
	"configUrl": "<nowiki>http://192.128.0.1:8080</nowiki>",		"configUrl": ""<nowiki>http://192.128.0.1:8080</nowiki>",
	"tags": ["REST example"],		"tags": ["REST example"],
	"properties": {		"properties": {

ENetrebin: Новая страница: «Конечная точка пользовательского устройства API топологии и Smartscape позволяет создать пол...»

2022-10-13T12:31:40Z

Новая страница: «Конечная точка пользовательского устройства API топологии и Smartscape позволяет создать пол...»

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

Конечная точка пользовательского устройства API топологии и Smartscape позволяет создать пользовательское устройство с указанным именем в вашей среде Ключ-АСТРОМ.

На этой странице описывается, как создать пользовательское устройство без отправки на него каких-либо данных.

Чтобы узнать, как передавать данные на пользовательское устройство, см. статью Отчет о метрике пользовательского устройства через REST API .

Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom/{customDeviceId}</nowiki></code>
|}

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

== Параметры ==
В этом случае элемент серии в тексте запроса должен быть опущен .
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимость
|-
|customDeviceId
|string
|Идентификатор пользовательского устройства.

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

Не используйте здесь идентификатор объекта Ключ-АСТРОМ.
|path
|требуется
|-
|body
|CustomDevicePushMessage
|Тело JSON запроса. Содержит параметры пользовательского устройства.
|body
|по желанию
|}

=== Объекты тела запроса ===

==== Объект <code>CustomDevicePushMessage</code> ====
Конфигурация пользовательского устройства.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|displayName
|нить
|Имя пользовательского устройства, которое будет отображаться в пользовательском интерфейсе.
|по желанию
|-
|group
|нить
|Определяемый пользователем идентификатор группы объекта.

Идентификатор группы помогает сохранить непротиворечивую картину отношений между группами устройств. Одним из многих случаев, когда важна правильная группа, является обнаружение службы: вы можете определить, какие пользовательские устройства должны вести к одной и той же службе, определив для них одинаковый идентификатор группы.

Если вы установите идентификатор группы, он будет хэширован в идентификатор объекта Ключ-АСТРОМ пользовательского устройства. В этом случае пользовательское устройство может быть частью только одной пользовательской группы устройств.

Если вы не укажете идентификатор группы, Ключ-АСТРОМ создаст ее на основе идентификатора или типа пользовательского устройства. Кроме того, группа не будет хеширована в идентификатор устройства, что означает, что устройство может переключаться между группами.
|по желанию
|-
|ipAddresses
|строка []
|Список IP-адресов, принадлежащих пользовательскому устройству.

Эти адреса используются для автоматического обнаружения горизонтальных коммуникационных отношений между этим компонентом и всеми другими наблюдаемыми компонентами в Smartscape. Как только соединение обнаружено, оно автоматически отображается и отображается в Smartscape.

Если вы отправите значение (включая пустое значение), существующие значения будут перезаписаны.

Если вы отправите <code>null</code>или опустите это поле, существующие значения будут сохранены.
|по желанию
|-
|listenPorts
|целое []
|Список портов, которые прослушиваются пользовательскими устройствами.

Эти порты используются для обнаружения горизонтальных коммуникационных отношений между этим компонентом и всеми другими наблюдаемыми компонентами в Smartscape.

Как только соединение обнаружено, оно автоматически отображается и отображается в Smartscape.

Если порты указаны, вы также должны добавить по крайней мере один IP-адрес или имя хоста для пользовательского устройства.

Если вы отправите значение, существующие значения будут перезаписаны.

Если вы отправите <code>null</code>, или пустое значение, или опустите это поле, существующие значения будут сохранены.
|по желанию
|-
|type
|нить
|Определение типа технологии пользовательского устройства.

Это должен быть тот же тип технологии, что и показатель, о котором вы сообщаете.

Если вы отправите значение, существующее значение будет перезаписано.

Если вы отправите <code>null</code>, очистите или опустите это поле, существующее значение будет сохранено.
|по желанию
|-
|favicon
|нить
|Значок, который будет отображаться для вашего пользовательского компонента в Smartscape. Укажите полный URL-адрес файла значка.
|по желанию
|-
|configUrl
|нить
|URL-адрес веб-страницы конфигурации пользовательского устройства, например страницы входа в брандмауэр или маршрутизатор.
|по желанию
|-
|properties
|object
|Список свойств пары "ключ-значение", которые будут отображаться под инфографикой вашего пользовательского устройства.
|по желанию
|-
|tags
|строка []
|Список пользовательских тегов, которые вы хотите прикрепить к своему пользовательскому устройству.
|по желанию
|-
|series
|EntityTimeseriesData[]
|Список значений метрик, о которых сообщается для пользовательского устройства.

Метрика, о которой вы сообщаете, уже должна существовать в Ключ-АСТРОМ. Чтобы узнать, как создать пользовательскую метрику, см. статью Timeseries API v1 — ВСТАВКА пользовательской метрики .

Ключ-АСТРОМ объединяет все значения, которые вы сообщаете для пользовательского устройства.

Если вы отправите значение (включая пустое значение), оно будет добавлено к набору существующих значений.

Если вы отправите <code>null</code>или опустите это поле, набор существующих значений не изменится.
|по желанию
|-
|hostNames
|строка []
|Список имен хостов, связанных с пользовательским устройством.

Эти имена используются для автоматического обнаружения горизонтальных коммуникационных отношений между этим компонентом и всеми другими наблюдаемыми компонентами в Smartscape. Как только соединение обнаружено, оно автоматически отображается и отображается в Smartscape.

Если вы отправите значение, существующие значения будут перезаписаны.

Если вы отправляете <code>null</code>или пустое значение; или опустите это поле, существующие значения будут сохранены.
|по желанию
|}

==== Объект <code>EntityTimeseriesData</code> ====
Информация о метрике и ее точках данных.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|timeseriesId
|нить
|Идентификатор метрики, в которую вы хотите опубликовать точки данных.
|требуется
|-
|dimensions
|object
|Размеры точек данных, которые вы публикуете.

Ключ измерения метрики должен быть определен ранее в определении метрики.
|по желанию
|-
|dataPoints
|array[]
|Список точек данных.

Каждая точка данных представляет собой массив, содержащий метку времени и значение.

Отметка времени — это миллисекунды UTC, представленные в виде числа, например: <code>1520523365557</code>.

У вас есть гарантированный таймфрейм на 30 минут в прошлое.

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

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"displayName": "coffeeMachine",
"group": "myCustomDeviceGroup",
"ipAddresses": [
"10.0.0.1"
],
"listenPorts": [
80
],
"favicon": "<nowiki>https://www.freefavicon.com/freefavicons/food/cup-of-coffee-152-78475.png</nowiki>",
"configUrl": "<nowiki>http://coffee-machine.ruscomtech.internal.com/coffeemachine/manage</nowiki>",
"type": "coffee machine",
"properties": {},
"tags": [
"office-linz"
],
"series": [
{
"timeseriesId": "custom:created.coffee.metric",
"dimensions": {
"office": "Linz"
},
"dataPoints": [
[
1521542929000,
13
]
]
}
],
"hostNames": [
"coffee-machine.ruscomtech.internal.com"
]
}</code>

== Ответ ==

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

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

==== Объект _ <code>CustomDevicePushResult</code> ====
Результат пользовательского push-запроса устройства. Идентификатор объекта рассчитывается автоматически.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|нить
|Идентификатор объекта Ключ-АСТРОМ пользовательского устройства.
|-
|groupId
|нить
|Идентификатор объекта Ключ-АСТРОМ пользовательской группы устройств.
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "string",
"groupId": "string"
}</code>

== Пример ==
В этом примере запрос создает пользовательское устройство <code>idOfmyCustomDevice</code>типа <code>F5-Firewall</code>, с IP-адресом <code>172.16.115.211</code>и портом прослушивания <code>9999</code>. В запросе также указываются некоторые дополнительные параметры.

См. раздел Отчет о метрике пользовательского устройства через API Ключ-АСТРОМ, чтобы узнать, как отправлять данные на вновь созданное пользовательское устройство.

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

Запрос возвращает идентификаторы пользовательского устройства (см. <code>entityId</code>) и его группы (см. <code>groupId</code>) в качестве подтверждения.

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно.

==== Curl ====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/custom/idOfmyCustomDevice</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
-H 'Content-Type: application/json' \
-d '{
"displayName" : "F5 Firewall 24",
"ipAddresses" : ["172.16.115.211"],
"listenPorts" : ["9999"],
"type" : "F5-Firewall",
"favicon" : "<nowiki>http://assets.ruscomtech.ru/global/icons/f5.png</nowiki>",
"configUrl" : "<nowiki>http://192.128.0.1:8080</nowiki>",
"tags": [
"REST example"
],
"properties" : {
"Sample Property 1": "Sample value 1"
}
}'</code>

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

==== Тело запроса ====
<code>{
"displayName": "F5 Firewall 24",
"ipAddresses": ["172.16.115.211"],
"listenPorts": ["9999"],
"type": "F5-Firewall",
"favicon": "http://assets.ruscomtech.ru<nowiki/>/global/icons/f5.png",
"configUrl": "<nowiki>http://192.128.0.1:8080</nowiki>",
"tags": ["REST example"],
"properties": {
"Sample Property 1": "Sample value 1"
}
}</code>

==== Тело ответа ====
<code>{
"entityId": "CUSTOM_DEVICE-6A567B33AADC306E",
"groupId": "CUSTOM_DEVICE_GROUP-FC2E2ABF54F513D8"
}</code>

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

==== Результат ====