RetrieveDomainTreeV2 – Получить список доменов, зарегистрированных в системе SoftWLC

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

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

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

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

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

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

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

Domain

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

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

code

Код ответа

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

detail

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

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

response

Объект NbiNameArray

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

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

8

Домен не соответствует правилам
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain>?</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>8</ns:code>
                <ns:detail>Domain '?' does not conform to the rules FQDN</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </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:RetrieveDomainTreeV2>
            <xsd:domain>re</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>62</ns:code>
                <ns:detail>Such 're' is not registered in ELTEX_EMS.DOMAINS</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

10

Домен роли не имеет прав на домен
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain>root</xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            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: 'root'. Role`s domains: 'enterprise.root test.root hotspot.root'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrieveDomainTreeV2>
            <xsd:domain></xsd:domain>
        </xsd:RetrieveDomainTreeV2>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrieveDomainTreeV2Response
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>enterprise.root</ns:name>
                    <ns:descr>Eterprise domain</ns:descr>
                    <ns:name>test.enterprise.root</ns:name>
                    <ns:descr>Test Eterprise domain</ns:descr>
                    <ns:name>lenina.enterprise.root</ns:name>
                    <ns:descr>Lenina Eterprise domain</ns:descr>
                    <ns:name>eltex-portal.enterprise.root</ns:name>
                    <ns:descr>Eltex-portal domain</ns:descr>
                    <ns:name>alpha.enterprise.root</ns:name>
                    <ns:descr>Alpha Eterprise domain</ns:descr>
                    <ns:name>test.root</ns:name>
                    <ns:descr>Root test domain</ns:descr>
                    <ns:name>spb.test.root</ns:name>
                    <ns:descr>Sanktpeterbugr test domain</ns:descr>
                    <ns:name>ekb.test.root</ns:name>
                    <ns:descr>Ekat tes domain</ns:descr>
                    <ns:name>barnaul.test.root</ns:name>
                    <ns:descr>Barnaul test domain</ns:descr>
                    <ns:name>kemerovo.test.root</ns:name>
                    <ns:descr>Kemerovo test domain</ns:descr>
                    <ns:name>krasnyi.test.root</ns:name>
                    <ns:descr>Krasnyi test domain</ns:descr>
                    <ns:name>ems.test.root</ns:name>
                    <ns:descr>Ems domain</ns:descr>
                    <ns:name>hotspot.root</ns:name>
                    <ns:descr>Hostpot root</ns:descr>
                    <ns:name>test.hotspot.root</ns:name>
                    <ns:descr>Test hotspot root</ns:descr>
                </ns:response>
            </ns:return>
        </ns:RetrieveDomainTreeV2Response>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.24-2769
Дата публикации 18-10-2022 03:26:05