initial public commit
This commit is contained in:
@ -0,0 +1,836 @@
|
||||
= Руководство по управлению коннекторами и профилями в шине.
|
||||
|
||||
_Профиль(profile)_ - это описание внешней системы в шине.(Например s1).
|
||||
|
||||
_Мостовой профиль(bridge-profile)_ - это профиль на другой стороне шины, ведущий через мост в профиль.
|
||||
(Например s1)
|
||||
|
||||
_Коннектор(connector)_ - это связь между интерфейсом, через который может работать система, и профилем.(Например uniform-service, nsi)
|
||||
|
||||
_Доступ(permission)_ - это разрешение на взаимодействие двух систем.(Например для того чтобы система s1 смогла отправить сообщение s2)(/permission-management)
|
||||
|
||||
_Учетная запись(account)_ - это учетная запись системы для взаимодействия с шиной.
|
||||
Для каждой системы должна быть учетная запись для возможности отправления сообщений в шину.
|
||||
Также есть учетные записи для возможности взаимодействия с управленческим слоем(т. е. для того чтобы управлять коннекторами/профилями/учетными записями/топиками нужна учетная запись с соответствующими правами)(/basic-auth-management)
|
||||
|
||||
Коннекторы делятся на входящие и исходящие(in, out), которые отвечают за отправку сообщения в определенный интерфейс и на получение ответа из определенного интерфейса соответственно.
|
||||
Например, для того чтобы иметь возможность отправить сообщение в soap нужно создать коннектор uniform-service-in-connector, а для того чтобы получить сообщение из soap нужно создать коннектор uniform-service-out-connector.
|
||||
|
||||
По адресу _/system-management-service_ находится сам сервис управления коннекторами и профилями в шине.
|
||||
|
||||
Для работы внешней системы в шине нужно сначала создать профиль данной системы в шине, потом добавлять к нему необходимые коннекторы и пробрасывать его в необходимые шины.
|
||||
|
||||
=== Управление профилями
|
||||
|
||||
*СreateProfile.*
|
||||
|
||||
Для создания профиля системы нужно вызвать метод createProfile, где вместо “system_uuid” нужно подставить uuid системы, вместо “system_name” - имя системы, “description” описание системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createProfileRequest>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:uuid>{{system_uuid}}</sys:uuid>
|
||||
<!--Optional:-->
|
||||
<sys:description>{{description}}</sys:description>
|
||||
</sys:createProfileRequest>
|
||||
</soapenv:Body>
|
||||
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль успешно создался, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetProfile.*
|
||||
|
||||
Проверить созданный профиль можно с помощью метода getProfile, где вместо “system_uuid” нужно подставить uuid системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getProfileRequest>
|
||||
<sys:uuid>{{system_uuid}}</sys:uuid>
|
||||
</sys:getProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (профиль со всеми зависимостями, либо ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<fullProfileType xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<profileName>w6</profileName>
|
||||
<uuid>w6</uuid>
|
||||
<description>description</description>
|
||||
<createDate>2020-01-22+03:00</createDate>
|
||||
<createdBy>System</createdBy>
|
||||
<type>false</type>
|
||||
<status>ACTIVE</status>
|
||||
<connectorList/>
|
||||
<esbNames/>
|
||||
</fullProfileType>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetProfiles*
|
||||
|
||||
Получить список профилей, зарегистрированных в шине, можно с помощью метода getProfiles:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:listProfileRequest/>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список профилей со всеми зависимостями, либо ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<listProfile xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<fullProfileType>
|
||||
<profileName>w6</profileName>
|
||||
<uuid>w6</uuid>
|
||||
<description>description</description>
|
||||
<createDate>2020-01-22+03:00</createDate>
|
||||
<createdBy>System</createdBy>
|
||||
<type>false</type>
|
||||
<status>ACTIVE</status>
|
||||
<connectorList/>
|
||||
<esbNames/>
|
||||
</fullProfileType>
|
||||
</listProfile>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StopProfile*
|
||||
|
||||
Остановить профиль и все его зависимости можно с помощью метода stopProfile, где вместо “system_uuid” нужно подставить uuid системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:stopProfileRequest>
|
||||
<sys:uuid>{{system_uuid}}</sys:uuid>
|
||||
</sys:stopProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль и его зависимости успешно остановились, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StartProfile*
|
||||
|
||||
Запустить профиль и все его зависимости можно с помощью метода startProfile, где вместо “system_uuid” нужно подставить uuid системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:stopProfileRequest>
|
||||
<sys:uuid>{{system_uuid}}</sys:uuid>
|
||||
</sys:stopProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль успешно запустился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*RemoveProfile*
|
||||
|
||||
Удалить профиль и все его зависимости можно с помощью метода removeProfile, где вместо “system_uuid” нужно подставить uuid системы(ВНИМАНИЕ!
|
||||
При удалении профиля также удаляются все связанные с ним коннекторы):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:stopProfileRequest>
|
||||
<sys:uuid>{{system_uuid}}</sys:uuid>
|
||||
</sys:stopProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль и его зависимости успешно удалился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
=== Управление коннекторами
|
||||
|
||||
*GetTemplates*
|
||||
|
||||
Для создания коннектора в шине нужно получить список шаблонов(требуются для создания коннекторов) методом getTemplates:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:listTemplateRequest/>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список шаблонов с параметрами):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<listTemplate xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<template>
|
||||
<templateName>file-out-connector</templateName>
|
||||
<paramList>
|
||||
<param>
|
||||
<name>directionTo</name>
|
||||
<value>file-to</value>
|
||||
</param>
|
||||
</paramList>
|
||||
</template>
|
||||
<template>
|
||||
<templateName>nsi-in-connector</templateName>
|
||||
<paramList/>
|
||||
</template>
|
||||
<template>
|
||||
<templateName>uniform-service-in-connector</templateName>
|
||||
<paramList/>
|
||||
</template>
|
||||
<template>
|
||||
<templateName>uniform-service-out-connector</templateName>
|
||||
<paramList>
|
||||
<param>
|
||||
<name>isActive</name>
|
||||
<value>false</value>
|
||||
</param>
|
||||
<param>
|
||||
<name>queue</name>
|
||||
<value>soap-root-default</value>
|
||||
</param>
|
||||
</paramList>
|
||||
</template>
|
||||
</listTemplate>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetTemplate*
|
||||
|
||||
Для создания коннектора в шине нужно получить список шаблонов(требуются для создания коннекторов) методом getTemplate, где “template_name” имя шаблона по которому будет сделан коннектор:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getTemplateRequest>
|
||||
<sys:templateName>{{template_name}}</sys:templateName>
|
||||
</sys:getTemplateRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (шаблон с параметрами):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<template xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<templateName>nsi-in-connector</templateName>
|
||||
<paramList/>
|
||||
</template>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*СreateConnector*
|
||||
|
||||
Для создания коннектора в шине нужно вызвать метод createConnector, где templateName - это имя шаблона, полученное из метода getTemplates, system_uuid - это uuid профиля, зарегистрированного в системе ранее, также нужно заполнить список параметров необходимый для создания коннектора(ВНИМАНИЕ! если не заполнить список параметров, то установятся значения по умолчанию) :
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createConnectorRequest>
|
||||
<sys:templateName>{{template_name}}</sys:templateName>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:paramList>
|
||||
<!--Zero or more repetitions:-->
|
||||
</sys:paramList>
|
||||
</sys:createConnectorRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если коннектор успешно создался, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetConnectors*
|
||||
|
||||
Можно просматривать список подключенных коннекторов в шине методом getConnectors:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:listConnectorRequest/>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список коннкторов с параметрами):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<listConnector xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<connector>
|
||||
<name>nsi-in-connector-w6</name>
|
||||
<status>ACTIVE</status>
|
||||
<paramList/>
|
||||
</connector>
|
||||
</listConnector>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StartConnector*
|
||||
|
||||
Запустить коннектор можно с помощью метода startConnector, где вместо “system_uuid” нужно подставить uuid системы, “template_name” это имя шаблона:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:startConnectorRequest>
|
||||
<sys:templateName>{{template_name}}</sys:templateName>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
</sys:startConnectorRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если коннектор успешно запустился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StopConnector*
|
||||
|
||||
Остановить коннектор можно с помощью метода stopConnector, где вместо “system_uuid” нужно подставить uuid системы, “template_name” это имя шаблона:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:stopConnectorRequest>
|
||||
<sys:templateName>{{template_name}}</sys:templateName>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
</sys:stopConnectorRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если коннектор успешно остановилась, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*RemoveConnector*
|
||||
|
||||
Удалить коннектор можно с помощью метода removeConnector, где вместо “system_uuid” нужно подставить uuid системы, “template_name” это имя шаблона:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:removeConnectorRequest>
|
||||
<sys:templateName>{{template_name}}</sys:templateName>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
</sys:removeConnectorRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если коннектор успешно удалился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
=== Управление мостовыми профилями
|
||||
|
||||
*GetListEsb*
|
||||
|
||||
Для получения списка подключенных шин можно с помощью метода getListEsb:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:listEsbRequest/>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список подключенных шин, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<listEsb xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<esbName>test1</esbName>
|
||||
</listEsb>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*CreateBridgeProfile*
|
||||
|
||||
Создать профиль, ведущий на мост, можно с помощью метода createBridgeProfile, где “system_uuid” uuid системы, “esb_name” имя подключенной шины:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createBridgeProfileRequest>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:esbName>{{esb_name}}</sys:esbName>
|
||||
</sys:createBridgeProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль, ведущий на мост, успешно создался, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StopBridgeProfile*
|
||||
|
||||
Остановить профиль, ведущий на мост, можно с помощью метода stopBridgeProfile, где “system_uuid” uuid системы, “esb_name” имя подключенной шины:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:stopBridgeProfileRequest>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:esbName>{{esb_name}}</sys:esbName>
|
||||
</sys:stopBridgeProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль, ведущий на мост, успешно остановился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*StartBridgeProfile*
|
||||
|
||||
Запустить профиль, ведущий на мост, можно с помощью метода startBridgeProfile, где “system_uuid” uuid системы, “esb_name” имя подключенной шины:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:startBridgeProfileRequest>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:esbName>{{esb_name}}</sys:esbName>
|
||||
</sys:startBridgeProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль, ведущий на мост, успешно запустился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetBridgeProfile*
|
||||
|
||||
Получить профиль, ведущий на мост, можно с помощью метода getBridgeProfile, где “system_uuid” uuid системы, “esb_name” имя подключенной шины:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getBridgeProfileRequest>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:esbName>{{esb_name}}</sys:esbName>
|
||||
</sys:getBridgeProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (профиль, ведущий на мост, пустой ответ):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<fullBridgeProfileType xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<profileName>w6</profileName>
|
||||
<status>ACTIVE</status>
|
||||
<esbName>test1</esbName>
|
||||
</fullBridgeProfileType>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*RemoveBridgeProfile*
|
||||
|
||||
Удалить профиль, ведущий на мост, можно с помощью метода removeBridgeProfile, где “system_uuid” uuid системы, “esb_name” имя подключенной шины:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:removeBridgeProfileRequest>
|
||||
<sys:profileUuid>{{system_uuid}}</sys:profileUuid>
|
||||
<sys:profileName>{{system_uuid}}</sys:profileName>
|
||||
<sys:esbName>{{esb_name}}</sys:esbName>
|
||||
</sys:removeBridgeProfileRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если профиль, ведущий на мост, успешно удален, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetBridgeProfiles*
|
||||
|
||||
Для получения списка профилей, ведущих на мост, можно использовать метод getBridgeProfiles:(ВНИМАНИЕ! запрос покажет список проброшенных профилей на ТЕКУЩЕЙ шине)
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getBridgeProfilesRequest/>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список профиль, ведущих на мост, пустой ответ):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<getBridgeProfilesResponse xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<fullBridgeProfileType>
|
||||
<profileName>w6</profileName>
|
||||
<status>ACTIVE</status>
|
||||
<esbName>test1</esbName>
|
||||
</fullBridgeProfileType>
|
||||
</getBridgeProfilesResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
=== Управление доступами
|
||||
|
||||
*CreatePermission*
|
||||
|
||||
Создать доступ одной системы к другой, можно с помощью метода createPermission, где “objectUuid” uuid системы, которой нужно дать доступ, “subjectUuid” - uuid системы, к которой нужно дать доступ:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createPermissionRequest>
|
||||
<sys:objectUuid>{{objectUuid}}</sys:objectUuid>
|
||||
<sys:subjectUuid>{{subjectUuid}}</sys:subjectUuid>
|
||||
</sys:createPermissionRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если доступ, успешно создался, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*RemovePermission*
|
||||
|
||||
Удалить доступ одной системы к другой, можно с помощью метода removePermission, где “objectUuid” uuid системы, которой нужно дать доступ, “subjectUuid” - uuid системы, к которой нужно дать доступ:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:removePermissionRequest>
|
||||
<sys:objectUuid>{{objectUuid}}</sys:objectUuid>
|
||||
<sys:subjectUuid>{{subjectUuid}}</sys:subjectUuid>
|
||||
</sys:removePermissionRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если доступ, успешно удалился, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetPermissionsByObject*
|
||||
|
||||
Получить список систем, доступ к которым от данной системы разрешен, можно с помощью метода getPermissionByObject, где “objectUuid” uuid системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getPermissionsByObjectRequest>
|
||||
<sys:uuid>{{objectUuid}}</sys:uuid>
|
||||
</sys:getPermissionsByObjectRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список систем, которым данная система может отправлять сообщения, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<getPermissionsByObjectResponse xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<profileType>
|
||||
<uuid>r2</uuid>
|
||||
</profileType>
|
||||
<profileType>
|
||||
<uuid>active</uuid>
|
||||
</profileType>
|
||||
</getPermissionsByObjectResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*GetPermissionsBySubject*
|
||||
|
||||
Получить список систем, доступ которым разрешен к данной системе, можно с помощью метода getPermissionBySubject, где “subjectUuid” uuid системы:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:getPermissionsBySubjectRequest>
|
||||
<sys:uuid>{{subjectUuid}}</sys:uuid>
|
||||
</sys:getPermissionsBySubjectRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (список систем, для которых данная система доступна для отправки сообщений, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<getPermissionsBySubjectResponse xmlns="http://www.entaxy.ru/system-management-service/">
|
||||
<profileType>
|
||||
<uuid>r2</uuid>
|
||||
</profileType>
|
||||
</getPermissionsBySubjectResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*CreatePermissionForObjectRequest*
|
||||
|
||||
Создать сразу несколько доступов, которым разрешено отправлять сообщения от данной системы, можно с помощью метода сreatePermissionForObjectRequest, где “objectUuid” это uuid системы, от которой буду исходить сообщения, ‘“subjectUuid1”, “subjectUuid2” и т д, это uuid систем, которым будут отправлять сообщения:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createPermissionForObjectRequest>
|
||||
<sys:objectUuid>{{objectUuid}}</sys:objectUuid>
|
||||
<!--Zero or more repetitions:-->
|
||||
<sys:subjectUuid>{{subjectUuid1}}</sys:subjectUuid>
|
||||
<sys:subjectUuid>{{subjectUuid2}}</sys:subjectUuid>
|
||||
</sys:createPermissionForObjectRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если доступа, успешно создались, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
|
||||
*CreatePermissionForSubjectRequest*
|
||||
|
||||
Создать сразу несколько доступов, которым разрешено отправлять сообщения в данную систему, можно с помощью метода сreatePermissionForSubjectRequest, где “objectUuid1”, “objectUuid2” и т д - это uuid систем, от которых буду исходить сообщения, ‘“subjectUuid” - это uuid системы, которой будут отправлять сообщения:
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="http://www.entaxy.ru/system-management-service/">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<sys:createPermissionForSubjectRequest>
|
||||
<!--Zero or more repetitions:-->
|
||||
<sys:objectUuid>{{objectUuid1}}</sys:objectUuid>
|
||||
<sys:objectUuid>{{objectUuid2}}</sys:objectUuid>
|
||||
<sys:subjectUuid>{{subjectUuid}}</sys:subjectUuid>
|
||||
</sys:createPermissionForSubjectRequest>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
----
|
||||
|
||||
Где ответом будет (“true” - если доступа, успешно создались, ошибка и ее описание):
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<response xmlns="http://www.entaxy.ru/system-management-service/">true</response>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
----
|
||||
Reference in New Issue
Block a user