GetAsyncProcessStatus - получить статус асинхронного процесса в EMS.

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

Команда актуальна, начиная с версии 1.21
Команда предназначена для получения статуса асинхронного процесса . Для того чтобы получить статус асинхронного процесса необходимо указать processId (Идентификатор асинхронного процесса).

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

Параметр	Значение	Формат значения	Расшифровка формата
processId	Идентификатор асинхронного процесса	int	Целое положительное число

Параметр

Значение

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

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

processId

Идентификатор асинхронного процесса

int

Целое положительное число

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

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число
detail	Пояснение к ответу	Текст английскими буквами с пробелами и спецсимволами.
message	Ответ от EMS	Текст английскими буквами с пробелами и спецсимволами.
processId	Идентификатор асинхронного процесса	Целое положительное число
status	Статус асинхронного процесса	Текст

Параметр

Значение

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

code

Код ответа

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

detail

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

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

message

Ответ от EMS

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

processId

Идентификатор асинхронного процесса

Целое положительное число

status

Статус асинхронного процесса

Текст

Возможные статусы

Финальный статус означает, что процесс в этом статусе завершен.

Статус	Описание	Финальный
NOT_START	Не запущен
WORKED	В работе
FINISHED	Завершен успешно	Да
LOCALE_ERROR	Завершен с проблемами	Да
FATAL_ERROR	Не планово завершен	Да
CANCELED	Прерван оператором	Да
UNKNOW	Неизвестный
WARN	Внимание (В работе)
RESPONSE	Ответ (В работе)
CANCELED_WITH_ERROR	Прерван, были ошибки	Да
TO_CONTINUE	Ожидание
ID_NOT_SPECIFIED	Не найден ID процесса	Да
NOT_FOUND	Не найден процесс с данным ID	Да

Статус

Описание

Финальный

NOT_START

Не запущен

WORKED

В работе

FINISHED

Завершен успешно

Да

LOCALE_ERROR

Завершен с проблемами

Да

FATAL_ERROR

Не планово завершен

Да

CANCELED

Прерван оператором

Да

UNKNOW

Неизвестный

WARN

Внимание (В работе)

RESPONSE

Ответ (В работе)

CANCELED_WITH_ERROR

Прерван, были ошибки

Да

TO_CONTINUE

Ожидание

ID_NOT_SPECIFIED

Не найден ID процесса

Да

NOT_FOUND

Не найден процесс с данным ID

Да

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

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

Код

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

Успешно

Запрос

Получение статуса асинхронного процесса.

   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAsyncProcessStatus>
         <nbi:process_Id>1</nbi:process_Id>
      </nbi:GetAsyncProcessStatus>
   </soapenv:Body>

Ответ

   <soapenv:Body>
      <ns:GetAsyncProcessStatusResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax21:AsyncProcessResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax21:message>OK</ax21:message>
            <ax21:processId>1</ax21:processId>
            <ax21:status>FINISHED</ax21:status>
         </ns:return>
      </ns:GetAsyncProcessStatusResponse>
   </soapenv:Body>

Код	Описание ошибки
281	Неверное задание идентификатора процесса

См. также

Вернуться к списку команд
Версия 1.29-3249
Дата публикации 21-12-2023 02:50:11