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

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

2023-02-03T14:49:18Z

← Предыдущая		Версия 14:49, 3 февраля 2023
Строка 57:		Строка 57:
	Идентификатор группы помогает сохранить непротиворечивую картину отношений между группами устройств. Одним из многих случаев, когда важна правильная группа, является обнаружение службы: вы можете определить, какие пользовательские устройства должны вести к одной и той же службе, определив для них одинаковый идентификатор группы.		Идентификатор группы помогает сохранить непротиворечивую картину отношений между группами устройств. Одним из многих случаев, когда важна правильная группа, является обнаружение службы: вы можете определить, какие пользовательские устройства должны вести к одной и той же службе, определив для них одинаковый идентификатор группы.

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

	Если вы не укажете идентификатор группы, ~~Ключ-АСТРОМ~~ создаст ее на основе идентификатора или типа пользовательского устройства. Кроме того, группа не будет хеширована в идентификатор устройства, что означает, что устройство может переключаться между группами.		Если вы не укажете идентификатор группы, Dynatrace создаст ее на основе идентификатора или типа пользовательского устройства. Кроме того, группа не будет хеширована в идентификатор устройства, что означает, что устройство может переключаться между группами.
	\|по желанию		\|по желанию
	\|-		\|-
Строка 139:		Строка 139:
	],		],
	"faviconUrl": "<nowiki>https://www.freefavicon.com/freefavicons/food/cup-of-coffee-152-78475.png</nowiki>",		"faviconUrl": "<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": {},
	"dnsNames": [		"dnsNames": [
	"coffee-machine.~~ruscomtech~~.internal.com"		"coffee-machine.dynatrace.internal.com"
	]		]
	}</code>		}</code>
Строка 179:		Строка 179:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ пользовательского устройства.		\|Идентификатор объекта Dynatrace пользовательского устройства.
	\|-		\|-
	\|groupId		\|groupId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ пользовательской группы устройств.		\|Идентификатор объекта Dynatrace пользовательской группы устройств.
	\|}		\|}

Строка 208:		Строка 208:

	==== Curl ====		==== Curl ====
	<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.~~ruscomtech~~.ru/api/v2/entities/custom'</nowiki> \		<code>curl -L -X POST '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/entities/custom'</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' \
	--data-raw '{		--data-raw '{
	"customDeviceId": "restExample",		"customDeviceId": "restExample",
	"displayName" : "F5 Firewall 24",		"displayName"N: "F5 Firewall 24",
	"ipAddresses" : ["172.16.115.211"],		"ipAddresses"e: ["172.16.115.211"],
	"listenPorts" : ["9999"],		"listenPorts"n: ["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>",
	"properties" : {		"properties"": {
	"Sample Property 1": "Sample value 1"		"Sample Property 1": "Sample value 1"
	}		}
Строка 226:		Строка 226:

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
	<code><nowiki>https://mySampleEnv.live.~~ruscomtech~~.com/api/v2/entities/custom</nowiki></code>		<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/entities/custom</nowiki></code>

	==== Тело запроса ====		==== Тело запроса ====
Строка 235:		Строка 235:
	"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>",
	"properties": {		"properties": {
	"Sample Property 1": "Sample value 1"		"Sample Property 1": "Sample value 1"

ENetrebin: Новая страница: «Создает или обновляет пользовательское устройство. Запрос потребляет и создает `applica...»`


2022-10-14T10:42:23Z
Новая страница: «Создает или обновляет пользовательское устройство.  Запрос потребляет и создает <code>applica...»
Новая страница
Создает или обновляет пользовательское устройство.



Запрос потребляет и создает <code>application/json</code>полезную нагрузку.

{| class="wikitable"

| rowspan="2" |POST

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/entities/custom</nowiki></code>

|-

|Cреда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entities/custom</nowiki></code>

|}



== Аутентификация ==

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



== Параметры ==

{| class="wikitable"

!Параметр

!Тип

!Описание

!In

!Необходимость

|-

|body

|CustomDeviceCreation

|Тело JSON запроса. Содержит параметры пользовательского устройства.

|body

|требуется

|}



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



==== Объект <code>CustomDeviceCreation</code> ====

Конфигурация пользовательского устройства.

{| class="wikitable"

!Элемент

!Тип

!Описание

!Необходимость

|-

|customDeviceId

|string

|Внутренний идентификатор пользовательского устройства.



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

|требуется

|-

|displayName

|string

|Имя пользовательского устройства, которое будет отображаться в пользовательском интерфейсе.

|требуется

|-

|group

|string

|Определяемый пользователем идентификатор группы объекта.



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



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



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

|по желанию

|-

|ipAddresses

|string []

|Список IP-адресов, принадлежащих пользовательскому устройству.



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



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



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

|по желанию

|-

|listenPorts

|integer []

|Список портов, которые прослушиваются пользовательскими устройствами.



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



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



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



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



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

|по желанию

|-

|type

|string

|Определение типа технологии пользовательского устройства.



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



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



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

|по желанию

|-

|faviconUrl

|string

|Значок, который будет отображаться для вашего пользовательского компонента в Smartscape. Укажите полный URL-адрес файла значка.

|по желанию

|-

|configUrl

|string

|URL-адрес веб-страницы конфигурации пользовательского устройства, например страницы входа в брандмауэр или маршрутизатор.

|по желанию

|-

|properties

|object

|Список свойств пары "ключ-значение", которые будут отображаться под инфографикой вашего пользовательского устройства.

|по желанию

|-

|dnsNames

|string []

|Список DNS-имен, связанных с пользовательским устройством.



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



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



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

|по желанию

|}



=== JSON-модель тела запроса ===

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

 <code>{

   "customDeviceId": "customDeviceId",

   "displayName": "coffeeMachine",

   "group": "myCustomDeviceGroup",

   "ipAddresses": [

     "10.0.0.1"

   ],

   "listenPorts": [

     80

   ],

   "faviconUrl": "<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": {},

   "dnsNames": [

     "coffee-machine.ruscomtech.internal.com"

   ]

 }</code>



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|201

|CustomDeviceCreationResult

|Успех

|-

|204

|

|Успех

|-

|400

|

|Не удалось. Ввод недействителен.

|}



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



==== Объект <code>CustomDeviceCreationResult</code> ====

Краткое представление вновь созданного пользовательского устройства.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|entityId

|string

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

|-

|groupId

|string

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

|}



=== JSON-модель тела ответа ===

 <code>{

   "entityId": "string",

   "groupId": "string"

 }</code>



== Пример ==

В этом примере запрос создает пользовательское устройство с идентификатором <code>restExample</code>и следующими параметрами:



* тип:<code>F5-Firewall</code>

* айпи адрес<code>172.16.115.211</code>

* слушать порт<code>9999</code>



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



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



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



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



==== Curl ====

 <code>curl -L -X POST '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/entities/custom'</nowiki> \

 -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

 -H 'Content-Type: application/json' \

 --data-raw '{

   "customDeviceId": "restExample",

   "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>",

   "properties" : {

     "Sample Property 1": "Sample value 1"

   }

 }

 '</code>



==== URL-адрес запроса ====

 <code><nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/entities/custom</nowiki></code>



==== Тело запроса ====

 <code>{

   "customDeviceId": "restExample",

   "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>",

   "properties": {

     "Sample Property 1": "Sample value 1"

   }

 }</code>



==== Тело ответа ====

 <code>{

   "entityId": "CUSTOM_DEVICE-1525F193C0578E2C",

   "groupId": "CUSTOM_DEVICE_GROUP-FC2E2ABF54F513D8"

 }</code>



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

201

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

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

ENetrebin: Новая страница: «Создает или обновляет пользовательское устройство. Запрос потребляет и создает applica...»

ENetrebin: Новая страница: «Создает или обновляет пользовательское устройство. Запрос потребляет и создает `applica...»`