Methods 1.1:getProgress/ru
From Aviberry API
К содержанию
Другие методы
Возникли вопросы?
getProgress - Метод возвращает подробную информацию о текущем состоянии задачи.
Для супер-задач кроме информации о родительской задаче возвращает также информацию обо всех подзадачах.
Contents |
Сигнатура
object getProgress( mixed conversion_id )
Параметры
conversion_id
conversion_id - Идентификатор задачи, прогресс которой необходимо получить, или массив таких идентификаторов.
Тип: mixed.
Возвращаемое значение
Тип: object.
Результат вызова метода - объект, содержащий пары ключ=значение, где ключ - это идентификатор задачи, а значение - объект, содержащий информацию о статусе задаче и имеющий следующий набор свойств:
conversion_id
conversion_id - Идентификатор задачи, для которой возвращена информация.
Тип: string.
status
status - Статус конвертации. Может иметь одно из значений указанных в разделе Статусы конвертации.
Тип: string.
percent
percent - Прогресс обработки (только для статусов downloading, converting, uploading). Может принимать значения от 0 до 100.
Тип: integer.
elapsed_time
elapsed_time - Время в секундах, прошедшее с начала конвертации (только для статуса converting).
Тип: integer.
remaining_time
remaining_time - Время в секундах, оставшееся до конца конвертации (только для статуса converting).
Тип: integer.
sent_bytes
sent_bytes - Переданный объем трафика, в байтах (только для статусов downloading и uploading).
Тип: integer.
total_bytes
total_bytes - Общий объем трафика, который нужно передать, в байтах (только для статусов downloading и uploading).
Тип: integer.
error_code
error_code - Код ошибки (только для статуса finished).
Тип: integer.
error_message
error_message - Расширенное сообщение об ошибке (только для статуса finished).
Тип: string.
queue
Тип: object.
queue - объект, со следующими свойствами:
| Свойство | Тип | Описание |
|---|---|---|
| tasks_before | integer | Количество задач в очереди перед текущей задачей. |
| time_to_shift | integer | Оценочное время, как скоро задача продвинется вперед в очереди. |
Эти параметры можно использоваться, чтобы определить, как скоро задача будет отправлена на обработку. Однако, нужно учитывать, что позиция задачи в очереди может не только уменьшаться, но и увеличиваться, в случае если приходит задача с более высоким приоритетом, см Сравнение тарифных планов.
Примеры
XML-RPC
Вызов getProgress
<methodCall>
<methodName>getProgress</methodName>
<params>
<param>
<value>2012_01-17_01_1936-72867900</value>
</param>
</params>
</methodCall>
Возвращаемое значение
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>2012_01-17_01_1936-72867900</name>
<value>
<struct>
<member>
<name>conversion_id</name>
<value>
<string>2012_01-17_01_1936-72867900</string>
</value>
</member>
<member>
<name>status</name>
<value>
<string>downloading</string>
</value>
</member>
<member>
<name>percent</name>
<value>
<i4>23</i4>
</value>
</member>
<member>
<name>elapsed_time</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>remaining_time</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>error_code</name>
<value>
<string/>
</value>
</member>
<member>
<name>error_message</name>
<value>
<string/>
</value>
</member>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
JSON-RPC
Вызов getProgress
{
"method":"getProgress",
"id":1,
"params":
{
"conversion_id":"2012_01-17_01_3403-88381000"
}
}
Возвращаемое значение
{
"version":"1.1",
"id":1,
"result":
{
"2012_01-17_01_3403-88381000":
{
"conversion_id":"2012_01-17_01_3403-88381000",
"status":"downloading",
"percent":31,
"elapsed_time":0,
"remaining_time":0,
"error_code":"",
"error_message":""
}
}
}
