GetSorm2ProfileList - Получить список СОРМ-2 съемников и их параметров

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

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

  2. Используется для получения списка СОРМ-2 съемников и их параметров для указанного домена. При использовании точки в начале домена в ответе придет список съемников для всех вложенных доменов.

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

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

domain

Домен установки съемника.

String

params

Дополнительные параметры выборки и фильтрации.

NbiParameterArray

В качестве дополнительных параметров (params) можно передать:

  • limit - максимальное число записей в выборке (по умолчанию 100)

  • offset - число записей, которые необходимо пропустить (для пагинации, по умолчанию 0)

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

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

profiles

Массив объектов NbiSorm2Profile, содержащий параметры СОРМ-2 съемников

NbiSorm2Profile

total

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

long

code

Код ответа

int

detail

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

String

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

Код Описание

0

Успешно
Запрос
<nbi:GetSorm2ProfileList>
 <nbi:domain>.root</nbi:domain>
 <nbi:params>
    <xsd:parameter>
       <xsd:name>limit</xsd:name>
       <xsd:value>10</xsd:value>
    </xsd:parameter>
    <xsd:parameter>
       <xsd:name>offset</xsd:name>
       <xsd:value>0</xsd:value>
    </xsd:parameter>
 </nbi:params>
</nbi:GetSorm2ProfileList>
Ответ
<ns:GetSorm2ProfileListResponse >
 <ns:return>
    <ax21:code>0</ax21:code>
    <ax21:detail/>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5def736861832a8ca998540a</ax258:id>
       <ax258:ip>1.1.2.2</ax258:ip>
       <ax258:name>Vostok SORN</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5df0acb272f1fd2afabb6eb3</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok2 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test.root</ax258:domain>
       <ax258:id>5df0afdf72f1fd2afabb7394</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok3 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:profiles>
       <ax258:description>xxx profile</ax258:description>
       <ax258:domain>test2.test.root</ax258:domain>
       <ax258:id>5df0b21072f1fd2afabb7754</ax258:id>
       <ax258:ip>1.1.2.3</ax258:ip>
       <ax258:name>Vostok4 SORM</ax258:name>
       <ax258:port>1812</ax258:port>
       <ax258:secret/>
    </ax258:profiles>
    <ax258:total>4</ax258:total>
 </ns:return>
</ns:GetSorm2ProfileListResponse>
Код Описание ошибки

441

Не настроен коннект к MongoDB sorm2

8

Недопустимое значение атрибута фильтрации Домен

10

Нет прав на указанный домен

62

Указанный домен не найден в базе доменов

Пример использования

См. также

Вернуться к списку команд
Версия 1.19-67
Дата публикации 07-05-2021 17:25:19