RetrieveRuleLinkList – Получить список связей устройств и правил инициализации

Общая информация

Команда актуальна, начиная с версии 1.5

Входные параметры

Параметр	Значение	Формат значения	Расшифровка формата
deviceKey	Поле для поиска по ключу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).	.*	Любые символы
ruleName	Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).	.*	Любые символы
ruleDomain	Поле для поиска по домену правил. Может быть пустым.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN.
nodeDomain	Поле для поиска по домену узла. Может быть пустым.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Параметр

Значение

Формат значения

Расшифровка формата

Ссылка

deviceKey

Поле для поиска по ключу устройства. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

Любые символы

ruleName

Поле для поиска по имени правила инициализации. Может быть пустым. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

Любые символы

ruleDomain

Поле для поиска по домену правил. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

nodeDomain

Поле для поиска по домену узла. Может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Выходные параметры

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число.
detail	Пояснение к ответу	Текст английскими буквами с пробелами и спецсимволами.
response	Массив объектов NbiProfileLink

Параметр

Значение

Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiProfileLink

Примеры команд и кодов

Код	Описание ошибки
10	Роль пользователя не имеет прав на домен правила или домен узла

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>test.re</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>10</ns:code>
                <ns:detail>The role of the user does not have rights to this domain: 'test.re'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
8	Домен правила или домен узла не пустой и не удовлетворяет правилам

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>s</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain 's' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
62	Домен правила или домен узла не пустой и не зарегистрирован

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveRuleLinkList>
            <xsd:deviceKey></xsd:deviceKey>
            <xsd:ruleName></xsd:ruleName>
            <xsd:ruleDomain>test1.root</xsd:ruleDomain>
            <xsd:nodeDomain></xsd:nodeDomain>
        </xsd:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 'test1.root' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
0	Успешно

Код

Описание ошибки

Успешно

Запрос

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrieveRuleLinkList>
            <nbi:deviceKey></nbi:deviceKey>
            <nbi:ruleName></nbi:ruleName>
            <nbi:ruleDomain>boxed.nsk.root</nbi:ruleDomain>
            <nbi:nodeDomain></nbi:nodeDomain>
        </nbi:RetrieveRuleLinkList>
    </soapenv:Body>
</soapenv:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveRuleLinkListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeProfileLinkResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiProfileLinkArray">
                    <ax21:link xsi:type="ax21:NbiProfileLink">
                        <ax21:deviceKey>1.2.5.3</ax21:deviceKey>
                        <ax21:deviceName>BOXX</ax21:deviceName>
                        <ax21:id>25</ax21:id>
                        <ax21:nodeDomain>boxed.nsk.root</ax21:nodeDomain>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>ActNumber</ax21:name>
                            <ax21:value>123456789</ax21:value>
                        </ax21:params>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>FullName</ax21:name>
                            <ax21:value>Ivanov A A</ax21:value>
                        </ax21:params>
                        <ax21:ruleDomain>boxed.nsk.root</ax21:ruleDomain>
                        <ax21:ruleName>boxed</ax21:ruleName>
                    </ax21:link>
                    <ax21:link xsi:type="ax21:NbiProfileLink">
                        <ax21:deviceKey>1.2.5.39</ax21:deviceKey>
                        <ax21:deviceName>BOXX</ax21:deviceName>
                        <ax21:id>26</ax21:id>
                        <ax21:nodeDomain>boxed.nsk.root</ax21:nodeDomain>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>ActNumber</ax21:name>
                            <ax21:value>123456789</ax21:value>
                        </ax21:params>
                        <ax21:params xsi:type="ax21:NbiParameter">
                            <ax21:name>FullName</ax21:name>
                            <ax21:value>Ivanov A A</ax21:value>
                        </ax21:params>
                        <ax21:ruleDomain>boxed.nsk.root</ax21:ruleDomain>
                        <ax21:ruleName>boxed</ax21:ruleName>
                    </ax21:link>
                </ax21:response>
            </ns:return>
        </ns:RetrieveRuleLinkListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.26-3053
Дата публикации 31-03-2023 06:03:06