-d, --dir=<DIR>

Каталог для сохранения загруженных файлов.

-i, --input-file=<FILE>

Загрузить URI, найденные в файле FILE. Вы можете указать несколько URI для одного объекта: разделяйте URI в строке, используя символ TAB (табуляция). Когда указано -, ввод считывается из stdin (стандартный поток ввода). Дополнительные параметры можно указывать после каждой строки с URI. Эта необязательная строка должна начинаться с одного или нескольких пробелов и содержать один параметр. Смотрите подраздел Входной файл для детальных пояснений. Также смотрите параметр --deferred-input.

-l, --log=<LOG>

Имя файла для журнала событий. Если указан -, то журнал событий будет записан в stdout (стандартный поток вывода). Если указана пустая строка (""), то журнал событий не будет записан в файл.

-j, --max-concurrent-downloads=<N>

Задать максимальное количество параллельных загрузок для каждого статического (HTTP/FTP) URI, torrent и metalink. Смотрите также параметр --split. По умолчанию: 5

-V, --check-integrity[=true|false]

Проверить целостность файла путем подтверждения хэшей блоков или хэша полного файла. Этот параметр влияет лишь на BitTorrent, Metalink или HTTP(S)/FTP загрузки с параметром --checksum. Параметр может обнаружить поврежденные части файла и перезагрузить их. Если есть хэш полного файла, то проверка выполняется только, когда файл уже полностью загружен. Момент полной загрузки определяется по размеру файла. Если проверка хэша завершилась неудачно, то файл будет перезагружен с нуля. Если есть хэши блоков и хэш полного файла, то будут использоваться только хэши блоков. По умолчанию: false

-c, --continue[=true|false]

Продолжить загрузку частично загруженного файла. Используйте этот параметр, чтобы возобновить загрузку, начатую в веб-браузере или в другой программе, которая загружает файлы последовательно сначала. Сейчас этот параметр можно использовать только для HTTP(S)/FTP-загрузок. По умолчанию: false

-h, --help[=<TAG>|<KEYWORD>]

Справочное сообщение определяется метками (TAG). Метки начинаются с #. Например, --help=#http даст справку по параметрам, помеченным меткой #http. Если задано слово (KEYWORD), не являющееся меткой, то будет выведена справка по параметрам, содержащих это слово. Возможные значения: #basic, #advanced, #http, #https, #ftp, #metalink, #bittorrent, #cookie, #hook, #file, #rpc, #checksum, #experimental, #deprecated, #help, #all. По умолчанию: #basic

--all-proxy=<PROXY>

Использовать указанный прокси-сервер для всех протоколов. Для стирания ранее определенного адреса используйте "". Вы можете отменить эту установку и указать прокси-сервер для отдельного протокола, используя параметры --http-proxy, --https-proxy и --ftp-proxy. Влияет на все URI. Формат PROXY - [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]. Смотрите также раздел ОКРУЖЕНИЕ.

Note

Если пользователь и пароль вставлены в URI-прокси и они также указаны в параметрах --{http,https,ftp,all}-proxy-{user,passwd}, то приоритетным будет самое последнее. Например, у вас http-proxy-user="myname", http-proxy-passwd="mypass" в aria2.conf и вы указали --http-proxy="http://proxy" в командной строке, тогда запрос к HTTP-прокси http://proxy будет с пользователем myname и паролем mypass.

 

Другой пример: если вы указали в командной строке --http-proxy="http://user:pass@proxy" --http-proxy-user="myname" --http-proxy-passwd="mypass", тогда запрос к HTTP-прокси http://proxy будет с пользователем myname и паролем mypass.

 

Еще один пример: если вы указали в командной строке --http-proxy-user="myname" --http-proxy-passwd="mypass" --http-proxy="http://user:pass@proxy", тогда запрос к HTTP-прокси http://proxy будет с пользователем user и паролем pass.

--all-proxy-passwd=<PASSWD>

Задать пароль для параметра --all-proxy.

--all-proxy-user=<USER>

Задать пользователя для параметра --all-proxy.

--checksum=<TYPE>=<DIGEST>

Задать контрольную сумму. TYPE - тип хэша. Поддерживаемые типы хэшей перечислены в Алгоритмы хэширования при aria2c -v. DIGEST - шестнадцатеричное значение хэша. Например, указание значения sha-1 хэша выглядит так: sha-1=0192ba11326fe2298c8cb4de616f4d4140213838 Этот параметр применим только к HTTP(S)/FTP загрузкам.

--connect-timeout=<SEC>

Задать в соединении время ожидания в секундах для установки подключения к HTTP/FTP/прокси-серверу. После установки подключения этот параметр не имеет значения, и вместо него используется параметр --timeout. По умолчанию: 60

--dry-run[=true|false]

Если задано true, aria2 только проверяет, является ли удаленный файл доступным и не загружает данные. Этот параметр влияет на HTTP/FTP-загрузку. BitTorrent-загрузки отменяются, если указано true. По умолчанию: false

--lowest-speed-limit=<SPEED>

Закрывать соединение, если скорость загрузки меньше чем или равна значению SPEED (байт в секунду). 0 означает, что aria2 не имеет нижнего ограничения скорости. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Этот параметр не влияет на BitTorrent-загрузки. По умолчанию: 0

-x, --max-connection-per-server=<NUM>

Максимально количество соединений с одним сервером для каждой загрузки. По умолчанию: 1

--max-file-not-found=<NUM>

Если aria2 получает статус "file not found" (файл не найден) с удаленных HTTP/FTP-серверов NUM раз без получения, хотя бы одного байта, тогда принудительно отказывается от загрузки. Укажите 0, чтобы отключить этот параметр. Этот параметр действенен только, когда используются HTTP/FTP-серверы. По умолчанию: 0

-m, --max-tries=<N>

Задать количество попыток. 0 означает неограниченно. Смотрите также --retry-wait. По умолчанию: 5

-k, --min-split-size=<SIZE>

aria2 не разбивает на части меньше чем 2*SIZE байт. Например, нужно загрузить файл размером 20МиБ. Если SIZE задать 10M, то aria2 может разбить файл на части в 2-ух диапазонах [0-10МиБ) и [10МиБ-20МиБ) и загрузить его, используя 2 источника (если --split >= 2, конечно же). Если SIZE задать 15M, т.к. 2*15M > 20MiB, aria2 не разобьет файл на части и загрузит его, используя 1 источник. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Возможные значения: 1M -1024M. По умолчанию: 20M

-n, --no-netrc[=true|false]

Отключить поддержку netrc. Поддержка netrc по умолчанию включена.

Note

Файл netrc считывается только при запуске, если --no-netrc задан как false. Так что если --no-netrc задан как true при загрузке, то netrc недоступен на протяжении всей сессии. Вы не сможете получить доступ к netrc, даже если отправите --no-netrc=false, используя aria2.changeGlobalOption().

--no-proxy=<DOMAINS>

Укажите через запятую имена хостов, домены и сетевые адреса с CIDR-блоком, или без него, для которых не будет использоваться прокси.

Note

CIDR-блок (метод IP-адресации, например 192.168.0.20/24) работает с IPv4- и IPv6-адресами. Текущая реализация не разрешает имена хостов в URI для сравнения сетевых адресов указанных в --no-proxy. Таким образом, это эффективно, только если в URI есть IP-адреса.

-o, --out=<FILE>

Сохранить загруженный файл под указанным именем. Если используется параметр --force-sequential, то данный параметр игнорируется.

Note

В Metalink или BitTorrent загрузках вы не можете указать имя файла. Имя файла указывается здесь, только когда используются URI и aria2 с командной строкой без параметров --input-file, --force-sequential. Например:

 

$ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
    

--proxy-method=<METHOD>

Задать метод для использования в прокси-запросах. METHOD один из двух: get или tunnel. HTTPS-загрузки всегда используют tunnel, не обращая внимания на этот параметр. По умолчанию: get

-R, --remote-time[=true|false]

Извлекать временную метку файла с удаленного HTTP/FTP-сервера и, если это доступно, применить ее к локальному файлу. По умолчанию: false

--reuse-uri[=true|false]

Повторно использовать уже использованные URI, если не осталось неиспользованных URI. По умолчанию: true

--retry-wait=<SEC>

Задать в секундах интервал ожидания между повторными попытками. При SEC > 0, если HTTP-сервер возвращает ответ 503, aria2 будет снова пытаться загрузить. По умолчанию: 0

--server-stat-of=<FILE>

Указать имя файла, в который сохраняется профиль функционирования сервера. Вы можете загрузить сохраненные данные, используя параметр --server-stat-if. Формат файла смотрите ниже в подразделе Профиль функционирования сервера.

--server-stat-if=<FILE>

Указать имя файла для загрузки профиля функционирования сервера. Загруженные данные будут использованы в некоторых URI селекторах, таких как feedback. Смотрите также параметр --uri-selector. Формат файла смотрите ниже в подразделе Профиль функционирования сервера.

--server-stat-timeout=<SEC>

Указывает время ожидания в секундах, для того, чтобы сделать недействительным профиль функционирования сервера, с тех пор, как состоялся последний контакт с ним. По умолчанию: 86400 (24 часа)

-s, --split=<N>

Загружать файл, используя N соединений. Если задано более чем N URI, будут использоваться первые N URI, а оставшиеся URI будут в резерве. Если задано менее чем N URI, то URI будут использованы более одного раза, так чтобы были задействованы все N соединений одновременно. Количество соединений к одному и тому же хосту ограничивается параметром --max-connection-per-server. Смотрите также параметр --min-split-size. По умолчанию: 5

Note

Некоторые Metalink регламентируют количество серверов для соединения. aria2 строго соблюдает это. Это значит, что если Metalink определяет атрибут maxconnections меньше чем N, то aria2 использует значение атрибута maxconnections вместо N.

--stream-piece-selector=<SELECTOR>

Указать алгоритм выбора блока, который используется в HTTP/FTP-загрузке. Блок - означает сегмент фиксированной длины, который загружается параллельно, в разделенной на части, загрузке. Если задано default, то aria2 выберет блок так, чтобы это уменьшило количество установленных подключений. Это разумное поведение по умолчанию, поскольку установка подключения очень затратная операция. Если задано inorder, то aria2 выберет блок, который имеет минимальный индекс. Index=0 означает первый из файла. Это будет полезно при просмотре фильма, в то время как он загружается. Параметр --enable-http-pipelining может быть полезен для снижения накладных расходов при повторном подключении. Обратите внимание, что aria2 принимает на обработку параметр --min-split-size, так что необходимо будет указать разумное значение параметра --min-split-size. Если задано geom, то aria2 вначале выберет блок с минимальным индексом, как при inorder, однако она сохранит экспоненциально большую область от ранее выбранного блока. Это уменьшит количество установленных подключений и в то же время это позволит в первую очередь загрузить начало файла. Это будет полезно при просмотре фильма, в то время как он загружается. По умолчанию: default

-t, --timeout=<SEC>

Задать время ожидания в секундах. По умолчанию: 60

--uri-selector=<SELECTOR>

Указать алгоритм выбора URI. Возможные значения: inorder, feedback и adaptive. Если задано inorder, то URI проверяются в порядке представления в списке URI. Если задано feedback, aria2 использует скорость загрузки, которая наблюдалась в предыдущих загрузках, и выбирает самый быстрый сервер в списке URI. Это также эффективно исключает мертвые зеркала. Наблюдаемая скорость загрузки является частью профиля функционирования сервера, упомянутой в параметрах --server-stat-of и --server-stat-if. Если задано adaptive, выбирается одно из лучших зеркал для первого и резервного соединений. Дополнительно, возвращаются зеркала, которые пока не были проверены, и, если каждое из них уже проверено, возвращаются зеркала, которые должны быть проверены снова. Иначе зеркала больше не выбираются. Подобно feedback, используются профиль функционирования сервера. По умолчанию: feedback

--ca-certificate=<FILE>

Использовать сертификат авторизации в FILE для проверки узлов. Сертификат должен быть в PEM-формате и содержать многоразовые CA-сертификаты. Используйте параметр --check-certificate, чтобы разрешить проверку.

--certificate=<FILE>

Использовать клиентский сертификат в FILE. Сертификат должен быть в PEM-формате. Вы можете использовать параметр --private-key, чтобы указать закрытый ключ.

--check-certificate[=true|false]

Проверять каждый из используемых сертификатов, которые указаны в параметре --ca-certificate. По умолчанию: true

--http-accept-gzip[=true|false]

Посылать Accept: deflate, gzip в запросе-заголовке и добавлять в ответ, если удаленный сервер ответит Content-Encoding: gzip или Content-Encoding: deflate. По умолчанию: 'false

Note

Некоторые серверы отвечают Content-Encoding: gzip для файлов, которые сами по себе сжаты (gzipped). aria2 добавляет их, так или иначе, из-за заголовка ответа.

--http-auth-challenge[=true|false]

Отправлять заголовок HTTP-авторизации только тогда, когда он запрошен с сервера. Если задано false, тогда заголовок авторизации всегда отправляется на сервер. Существует исключение: если имя пользователя и пароль являются встроенными в URI, то заголовок авторизации всегда отправляется на сервер, независимо от этого параметра. По умолчанию: false

--http-no-cache[=true|false]

Отправлять заголовок Cache-Control: no-cache и Pragma: no-cache, чтобы избежать кэширования содержимого. Если задано false, то эти заголовки не посылаются, и вы можете добавить любую директиву к заголовку Cache-Control с помощью параметра --header. По умолчанию: true

--http-user=<USER>

Задать пользователя для HTTP. Влияет на все URI.

--http-passwd=<PASSWD>

Задать пароль для HTTP. Влияет на все URI.

--http-proxy=<PROXY>

Использовать указанный прокси-сервер для HTTP. Ранее указанный адрес можно стереть, указав "". Смотрите также параметр --all-proxy. Влияет на все URI. Формат PROXY - [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ].

--http-proxy-passwd=<PASSWD>

Задать пароль для параметра --http-proxy.

--http-proxy-user=<USER>

Задать пользователя для параметра --http-proxy.

--https-proxy=<PROXY>

Использовать указанный прокси-сервер для HTTPS. Ранее указанный адрес можно стереть, указав "". Смотрите также параметр --all-proxy. Влияет на все URI. Формат PROXY - [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ].

--https-proxy-passwd=<PASSWD>

Задать пароль для параметра --https-proxy.

--https-proxy-user=<USER>

Задать пользователя для параметра --https-proxy.

--private-key=<FILE>

Использовать закрытый ключ в FILE. Закрытый ключ должен быть дешифрованным и в PEM-формате. Режим работы с исходно зашифрованным закрытым ключом не определен. Смотрите также параметр --certificate.

--referer=<REFERER>

Задать источника запроса. Влияет на все URI.

--enable-http-keep-alive[=true|false]

Включить HTTP/1.1 постоянное соединение. По умолчанию: true

--enable-http-pipelining[=true|false]

Включить конвейерную обработку HTTP/1.1. По умолчанию: false

Note

С точки зрения производительности, как правило, нет преимущества от включения этого параметра.

--header=<HEADER>

Добавлять HEADER к HTTP запросу-заголовку. Вы можете использовать этот параметр повторно, чтоб указать более одного заголовка:

 

$ aria2c --header="X-A: b78" --header="X-B: 9J1" "http://host/file"
    

--load-cookies=<FILE>

Загружать куки-файл из FILE, используя форматы Firefox3 (SQLite3), Chromium/Google Chrome (SQLite3) и Mozilla/Firefox(1.x/2.x)/Netscape.

Note

Если aria2 собрана без libsqlite3, то форматы куки-файлов Firefox3 и Chromium/Google Chrome не поддерживаются.

--save-cookies=<FILE>

Сохранить куки в FILE формате Mozilla/Firefox(1.x/2.x)/Netscape. Если FILE уже существует, то он будет перезаписан. Куки-сессия также сохранится, и значение ее окончания будет трактоваться как 0. Возможные значения: /путь/к/файлу

--use-head[=true|false]

Использовать метод HEAD для первого запроса к HTTP серверу. По умолчанию: false

-U, --user-agent=<USER_AGENT>

Задать клиентское приложение для HTTP(S)-загрузок. По умолчанию: aria2/$VERSION, $VERSION заменяется на версию пакета.

--ftp-user=<USER>

Задать пользователя для FTP. Влияет на все URI. По умолчанию: anonymous

--ftp-passwd=<PASSWD>

Задать пароль для FTP. Влияет на все URI. Если имя пользователя встроено, но пароль отсутствует в URI, то aria2 пытается использовать пароль из .netrc. Если пароль найден в .netrc, то он используется. Если нет, используется пароль, указанный в этом параметре. По умолчанию: ARIA2USER@

-p, --ftp-pasv[=true|false]

Использовать пассивный режим FTP. Если задано false, то будет использован активный режим. По умолчанию: true

--ftp-proxy=<PROXY>

Использовать указанный прокси-сервер для FTP. Ранее указанный адрес можно стереть, указав "". Смотрите также параметр --all-proxy. Влияет на все URI. Формат PROXY - [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]

--ftp-proxy-passwd=<PASSWD>

Задать пароль для параметра --ftp-proxy.

--ftp-proxy-user=<USER>

Задать пользователя для параметра --ftp-proxy.

--ftp-type=<TYPE>

Задать тип передачи для FTP. TYPE может быть один из двух: binary или ascii. По умолчанию: binary

--ftp-reuse-connection[=true|false]

Повторно использовать FTP соединение. По умолчанию: true

--select-file=<INDEX>...

Задать файл для загрузки по заданному индексу. Вы можете найти индекс файла, используя параметр --show-files. Составной индекс можно указать, используя ,, например: 3,6. Вы можете также использовать -, чтобы указать диапазон: 1-5. , и - могут быть использованы вместе: 1-5,8,9. Когда используется с параметром -M, индекс может сильно зависеть от запроса (смотрите параметры --metalink-*).

Note

В многофайловом торренте, смежные файлы, указанные в этом параметре также могут быть загружены. Это не ошибка, а особенность утилиты. Одиночный блок данных может включать несколько файлов или часть файла, и aria2 запишет блок данных соответствующего файла.

-S, --show-files[=true|false]

Вывести список файлов из .torrent, .meta4 или .metalink и выйти. Для файла .torrent будет выведена более детальная информация (информация по хэшу, размер блока и др.).

--bt-enable-lpd[=true|false]

Включить поиск локальных пиров. Если в torrent-файле установлен приватный признак, то aria2 не будет использовать эту возможность, даже если задано true. По умолчанию: false

--bt-exclude-tracker=<URI>[,...]

Разделенный запятыми список URI анонса BitTorrent-трекера, которые будут исключены. Вы можете использовать специальное значение *, которое соответствует всем URI, таким образом, исключаются все URI анонса. При указании * в оболочке командной строке, не забывайте, экранировать или брать в кавычки. Смотрите также параметр --bt-tracker.

--bt-external-ip=<IPADDRESS>

Указать внешний IP-адрес BitTorrent-трекера для отчета. Не смотря на то, что эта функция названа external (внешний), она может принимать любой IP-адрес. IPADDRESS должен быть числовым IP-адресом.

--bt-hash-check-seed[=true|false]

Если задано true, то после проверки хэша с использованием параметра --check-integrity, и когда файл загружен полностью, продолжается раздача файла. Если вы хотите проверить файл и загрузить его только если он поврежден или не загружен полностью, то задайте этот параметр как false. Этот параметр влияет лишь на BitTorrent-загрузки. По умолчанию: true

--bt-lpd-interface=<INTERFACE>

Использовать для поиска локальных пиров заданный интерфейс. Если этот параметр не указан, используется интерфейс по умолчанию. Можно указать имя интерфейса и IP-адрес. Возможные значения: интерфейс, IP-адрес.

--bt-max-open-files=<NUM>

Указать максимальное количество файлов для открытия в каждой BitTorrent-загрузке. По умолчанию: 100

--bt-max-peers=<NUM>

Указать максимальное количество узлов для каждого торрента. 0 означает неограниченно. Смотрите также параметр --bt-request-peer-speed-limit. По умолчанию: 55

--bt-metadata-only[=true|false]

Загрузить только метаданные. Файл(ы), описывающий метаданные не должен быть загружен. Этот параметр эффективен, только если используется BitTorrent Magnet-ссылка. Смотрите также параметр --bt-save-metadata. По умолчанию: false

--bt-min-crypto-level=plain|arc4

Задать минимальный уровень метода шифрования. Если узел поддерживает несколько методов шифрования, aria2 выбирает наименьший, который удовлетворяет заданный уровень. По умолчанию: plain

--bt-prioritize-piece=head[=<SIZE>],tail[=<SIZE>]

Пытаться загрузить сначала первую и последнюю части каждого файла. Это бывает полезно для предварительного просмотра файлов. Аргумент может содержать 2 ключевых слова: head и tail. Для включения обоих, необходимо разделить их запятой. Ключевые слова принимают один параметр, SIZE. Например, если указано head=<SIZE>, части, в пределах первых SIZE байт каждого файла, получат повышенный приоритет. tail=<SIZE> обозначает диапазон из последних SIZE байт каждого файла. SIZE может включать букву K или M для обозначения размера в килобайтах или мегабайтах, соответственно (1K = 1024, 1M = 1024K). Если SIZE пропущено, то будет использовано по умолчанию значение: SIZE=1M.

--bt-remove-unselected-file[=true|false]

Удалить невыбранные файлы, когда завершена загрузка в BitTorrent. Чтобы выбрать файлы, используйте параметр --select-file. Если не использовался этот параметр, то предполагается, что все файлы выбраны. Пожалуйста, используйте этот параметр внимательно, так как это фактически удалит файлы с вашего диска. По умолчанию: false

--bt-require-crypto[=true|false]

Если задано true, aria2 не принимает и не устанавливает соединение с унаследованным BitTorrent handshake-сообщением (рукопожатие) (BitTorrent протокол). Таким образом, aria2 всегда использует обфускацию handshake-сообщения. По умолчанию: false

--bt-request-peer-speed-limit=<SPEED>

Если итоговая скорость загрузки каждого торрента, ниже чем SPEED, aria2 временно увеличивает количество узлов, пытаясь увеличить скорость загрузки. Настройка этого параметра с выбранной вами скоростью загрузки может, в некоторых случаях, увеличить вашу скорость загрузки. Вы можете добавить K или M (1K = 1024, 1M = 1024K). По умолчанию: 50K

--bt-save-metadata[=true|false]

Сохранить метаданные как файл .torrent. Этот параметр эффективен только если используется BitTorrent Magnet-ссылка. Имя файла шестнадцатеричное представление хэша с расширением сохранится загружаемый файл. Если тот же самый файл уже существует, метаданные не сохранятся. Смотрите также параметр --bt-metadata-only. По умолчанию: false

--bt-seed-unverified[=true|false]

Раздавать первоначально загруженные файлы без проверки хэшей блоков. По умолчанию: false

--bt-stop-timeout=<SEC>

Остановить BitTorrent загрузку, если скорость загрузки равна 0 на протяжении SEC секунд. Если задано 0, то эта возможность не будет использоваться. По умолчанию: 0

--bt-tracker=<URI>[,...]

Разделенный запятыми список дополнительных URI анонса BitTorrent-трекеров. На эти URI не действует параметр --bt-exclude-tracker, потому что они добавляются после URI, указанных в параметре --bt-exclude-tracker, которые исключаются.

--bt-tracker-connect-timeout=<SEC>

Задать время ожидания в секундах для установки соединения с трекером. После установки соединения, это параметр станет не действительным, а вместо него будет использован --bt-tracker-timeout. По умолчанию: 60

--bt-tracker-interval=<SEC>

Задать интервал в секундах между запросами трекера. Это полностью отменяет значение интервала и aria2 использует только это значение и игнорирует минимальный интервал и значение интервала в ответе трекера. Если задан 0, aria2 определяет интервал, основываясь на ответе трекера и прогрессе загрузки. По умолчанию: 0

--bt-tracker-timeout=<SEC>

Задать время ожидания в секундах. По умолчанию: 60

--dht-entry-point=<HOST>:<PORT>

Задать хост и порт, как точку входа в IPv4 DHT сеть.

--dht-entry-point6=<HOST>:<PORT>

Задать хост и порт, как точку входа в IPv6 DHT сеть.

--dht-file-path=<PATH>

Заменять файл таблицы маршрутизации IPv4 DHT на PATH. По умолчанию: $HOME/.aria2/dht.dat

--dht-file-path6=<PATH>

Заменять файл таблицы маршрутизации IPv6 DHT на PATH. По умолчанию: $HOME/.aria2/dht.dat

--dht-listen-addr6=<ADDR>

Указать адрес привязки сокета для IPv6 DHT. Он должен быть глобальным IPv6 unicast-адресом хоста.

--dht-listen-port=<PORT>...

Задать прослушиваемый UDP-порт для обоих IPv4 и IPv6 DHT. Несколько портов можно указать через ,, например: 6881,6885. Вы также можете использовать - чтобы указать диапазон: 6881-6999. , и - могут быть использованы вместе. По умолчанию: 6881-6999

Note

Удостоверьтесь, что указанные порты открыты для входящего UDP-трафика.

--dht-message-timeout=<SEC>

Задать время ожидания в секундах. По умолчанию: 10

--enable-dht[=true|false]

Включить IPv4 DHT функциональность. Если в torrent-файле задан приватный признак, aria2 не будет использовать DHT для загрузки, даже если установлен true. По умолчанию: true

--enable-dht6[=true|false]

Включить IPv6 DHT функциональность. Если в torrent-файле задан приватный признак, aria2 не будет использовать DHT для загрузки, даже если установлен true. Используйте параметр --dht-listen-port для указания прослушиваемого порта. Смотрите также параметр --dht-listen-addr6.

--enable-peer-exchange[=true|false]

Включить расширение BitTorrent-протокола для обмена списками участников. Если в torrent-файле задан приватный признак, то эта возможность будет отключена, даже если установлен true. По умолчанию: true

--follow-torrent=true|false|mem

Если указать true или mem, тогда загруженный файл, расширение которого - .torrent или mime-тип - application/x-bittorrent, aria2 анализирует как torrent-файл и загружает файлы, указанные в нем. Если указано mem, тогда torrent-файл не записывается на диск, а содержится в памяти. Если указано false, действия, упомянутые выше, не совершаются. По умолчанию: true

-O, --index-out=<INDEX>=<PATH>

Задать путь к файлу PATH с индексом INDEX. Вы можете найти индекс файла, используя параметр --show-files. PATH является относительным путем к тому, который указан в параметре --dir. Вы можете использовать этот параметр много раз. Используйте этот параметр, когда хотите указать имена выходных файлов для BitTorrent-загрузок.

--listen-port=<PORT>...

Задать номер TCP-порта для BitTorrent-загрузок. Несколько портов можно указать, используя ,, например: 6881,6885. Вы также можете использовать -, чтобы указать диапазон: 6881-6999. , и - могут быть использованы вместе: 6881-6889,6999. По умолчанию: 6881-6999

Note

Удостоверьтесь, что указанные порты открыты для входящего TCP-трафика.

--max-overall-upload-limit=<SPEED>

Задать максимальную общую скорость отдачи в байтах/сек. 0 значит неограниченно. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Чтобы ограничить скорость отдачи для узла торрента, используйте параметр --max-upload-limit. По умолчанию: 0

-u, --max-upload-limit=<SPEED>

Задать максимальную скорость отдачи каждого узла торрента в байтах/сек. 0 значит неограниченно. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Чтобы ограничить общую скорость отдачи, используйте параметр --max-overall-upload-limit. По умолчанию: 0

--peer-id-prefix=<PEER_ID_PREFIX>

Указать префикс для ID узла. ID узла в BitTorrent имеет размер 20 байт. Если будет указано более 20 байт, то только первые 20 будут использоваться, если будет указано меньше 20, то они будут дополнены случайными данными до 20 байт. По умолчанию: aria2/$VERSION, $VERSION заменяется на версию пакета.

--seed-ratio=<RATIO>

Указать рейтинг. Сидировать завершенные торренты, пока рейтинг не станет больше RATIO. Очень рекомендуется указать тут равный или больший 1.0. Указать 0.0, если вы планируете сидировать независимо от рейтинга. Если указан параметр --seed-time вместе с этим параметром, сидирование закончится тогда, когда хотя бы одно условие будет удовлетворено. По умолчанию: 1.0

--seed-time=<MINUTES>

Указать время сидирования (раздачи) в минутах. Смотрите также параметр --seed-ratio.

Note

Указанный --seed-time=0 отключает сидирование после завершения загрузки.

-T, --torrent-file=<TORRENT_FILE>

Путь к файлу .torrent. Вы не обязаны использовать этот параметр, т.к. файл .torrent можно указать без --torrent-file.

--follow-metalink=true|false|mem

Если указано true или mem и когда загруженный файл имеет расширение .meta4 или .metalink, или mime-тип application/metalink4+xml или application/metalink+xml, aria2 считает его metalink-файлом и загружает упомянутые в нем файлы. Если указано mem, то metalink-файл не сохраняется на диск, а просто хранится в памяти. Если указано false, то вышеприведенная операция не производится. По умолчанию: true

--metalink-base-uri=<URI>

Указать основной URI для разрешения относительных URI в элементе metalink:url и metalink:metaurl в metalink-файле, сохраненном на локальном диске. Если URI указывает на каталог, то URI должен заканчиваться на /.

-M, --metalink-file=<METALINK_FILE>

Путь к файлу .meta4 и .metalink. Читает ввод из stdin, если в качестве имени файла указано -. Вы не обязаны использовать этот параметр, т.к. файлы .metalink можно указать без --metalink-file.

--metalink-language=<LANGUAGE>

Язык файла для загрузки.

--metalink-location=<LOCATION>[,...]

Местонахождение предпочитаемого сервера. Список, разделенный запятыми, допустимых местонахождений, например, jp,us.

--metalink-os=<OS>

Целевая операционная система файла для загрузки.

--metalink-version=<VERSION>

Версия файла для загрузки.

--metalink-preferred-protocol=<PROTO>

Указать предпочитаемый протокол. Возможные значения: http, https, ftp и none. Указать none для отключения этой возможности. По умолчанию: none

--metalink-enable-unique-protocol[=true|false]

Если задано true, а в metalink-файле доступно несколько протоколов, то aria2 использует один из них. Используйте параметр --metalink-preferred-protocol, чтобы указать предпочитаемый протокол. По умолчанию: true

--enable-rpc[=true|false]

Включить JSON-RPC/XML-RPC-сервер. Настоятельно рекомендуется указать имя пользователя и пароль, используя параметры --rpc-user и --rpc-passwd. Смотрите также параметр --rpc-listen-port. По умолчанию: false

--pause[=true|false]

Приостановка загрузки после добавления. Этот параметр действенен только, когда задан --enable-rpc=true. По умолчанию: false

--rpc-allow-origin-all[=true|false]

Добавить заголовок Access-Control-Allow-Origin со значением * в RPC-ответе. По умолчанию: false

--rpc-listen-all[=true|false]

Слушать входящие JSON-RPC/XML-RPC-запросы на всех сетевых интерфейсах. Если указано false, слушать только на локальном петлевом интерфейсе (loopback). По умолчанию: false

--rpc-listen-port=<PORT>

Указать номер порта, для прослушивания JSON-RPC/XML-RPC-сервером. Возможные значения: 1024 -65535. По умолчанию: 6800

--rpc-max-request-size=<SIZE>

Задать максимальный размер JSON-RPC/XML-RPC-запроса. Если aria2 выявит запрос с размером большим, чем SIZE байт, тогда соединение будет отклонено. По умолчанию: 2M

--rpc-passwd=<PASSWD>

Задать JSON-RPC/XML-RPC пароль.

--rpc-user=<USER>

Задать JSON-RPC/XML-RPC пользователя.

--allow-overwrite[=true|false]

Повторно запустить загрузку с нуля, если соответствующий контрольный файл отсутствует. Смотрите также параметр --auto-file-renaming. По умолчанию: false

--allow-piece-length-change[=true|false]

Если задано false, aria2 прерывает загрузку, когда длина блока отлична от той, которая находится в контрольном файле. Если задано true, вы можете продолжать, однако некоторый прогресс загрузки будет потерян. По умолчанию: false

--always-resume[=true|false]

Всегда возобновлять загрузку. Если задано true, aria2 всегда пытается возобновить загрузку и если это не возможно, прерывает ее. Если задано false, тогда для всех заданных URI не поддерживается возобновление загрузки, или aria2 столкнется с невозможностью возобновления загрузки URI N-ое количество раз (значение N указывается в параметре --max-resume-failure-tries, то aria2 будет загружать файл с нуля. Смотрите параметр --max-resume-failure-tries. По умолчанию: true

--async-dns[=true|false]

Включить асинхронный DNS. По умолчанию: true

--async-dns-server=<IPADDRESS>[,...]

Разделенный запятыми список адресов DNS-серверов, которые используют асинхронный DNS-преобразователь. Обычно асинхронный DNS-преобразователь читает адреса DNS-серверов из /etc/resolv.conf. Когда используется этот параметр, то используются DNS-серверы, указанные в параметре вместо указанных в /etc/resolv.conf. Вы можете указать оба IPv4 и IPv6 адреса. Этот параметр полезен, когда в системе нет /etc/resolv.conf и у пользователя нет прав на его создание.

--auto-file-renaming[=true|false]

Переименовать файл, если такой уже существует. Этот параметр работает только для HTTP(S)/FTP-загрузок. К имени файла будет добавлена точка и число от 1 до 9999. По умолчанию: true

--auto-save-interval=<SEC>

Сохранять контрольный файл (*.aria2) каждые SEC секунд. Если задано 0, тогда контрольный файл не сохраняется на протяжении загрузки. aria2 сохраняет контрольный файл тогда, когда останавливается, не смотря на значение. Возможные значения: от 0 до 600. По умолчанию: 60

--conditional-get[=true|false]

Загружать файл только когда локальный файл старше, чем удаленный. Эта функция работает только для HTTP(S)-загрузок. Это не работает, если размер файла указан в Metalink. Это также игнорирует заголовок Content-Disposition. Если контрольный файл существует, то этот параметр игнорируется. Эта функция использует заголовок If-Modified-Since, как условие для получения только нового файла. При получении времени модификации локального файла, используется указанное пользователем имя файла (см. параметр --out) или часть имени файла в URI, если --out не указан. Для перезаписи существующего файла необходим параметр --allow-overwrite. По умолчанию: false

--conf-path=<PATH>

Сменить путь к файлу конфигурации на PATH. По умолчанию: $HOME/.aria2/aria2.conf

-D, --daemon[=true|false]

Запустить как демон (фоновый процесс). Текущий рабочий каталог будет заменен на /, а стандартный ввод, стандартный вывод, стандартный вывод ошибок будут перенаправлены на /dev/null. По умолчанию: false

--deferred-input[=true|false]

Если задано true, aria2 при запуске не считывает все URI и параметры из файла, указанного в параметре --input-file, а считывает их позже отдельно, когда это нужно. Это может сократить использование памяти, если во входном файле содержится много URI для загрузки. Если задано false, aria2 при запуске считывает все URI и параметры. По умолчанию: false

--disable-ipv6[=true|false]

Отключить IPv6. Это полезно, если вы используете поврежденный DNS и хотите избежать ужасно медленного поиска AAAA-записи. По умолчанию: false

--download-result=<OPT>

Этот параметр изменяет формат сообщения Результаты загрузки. Если OPT задан как default, то отображается GID, статус, средняя скорость загрузки и путь/URI. Если загружается множество файлов, то отобразиться путь/URI первого запрашиваемого файла, а остальные пропускаются. Если OPT задан как full, то отображается GID, статус, средняя скорость загрузки, процент прогресса и путь/URI. Процент прогресса и путь/URI отобразиться для каждого запрашиваемого файла в отдельной строке. По умолчанию: default

--enable-async-dns6[=true|false]

Включить IPv6 разрешение имен в асинхронном DNS-преобразователе. Этот параметр будет игнорироваться, если --async-dns=false. По умолчанию: false

--event-poll=<POLL>

Указать метод опроса событий. Возможные значения: epoll, kqueue, port, poll и select. Каждый метод epoll, kqueue, port и poll доступен, если система поддерживает его. epoll доступен в современных дистрибутивах Linux. kqueue доступен в различных *BSD-системах, включая Mac OS X. port доступен в Open Solaris. Значение по умолчанию может изменяться в зависимости от системы, которую вы используете.

--file-allocation=<METHOD>

Указать метод резервирования места для файла. none не происходит предварительное резервирование места для файла. prealloc - предварительное резервирование места для файла перед началом загрузки. Это может продолжаться некоторое время, в зависимости от размера файла. Если вы используете новые файловые системы, наподобие ext4 (с поддержкой экстентов), btrfs, xfs или NTFS (только сборка MinGW) тогда лучше выбрать falloc. Так как они резервируют место под большие (на несколько Гигабайт) файлы почти мгновенно. Не используйте falloc вместе с наследными файловыми системами, такими как ext3 и FAT32, потому что это будет продолжаться почти столько же времени, как и prealloc, а также полностью заблокирует aria2, пока не закончится резервирование места. falloc может быть недоступным, если ваша система не содержит функцию posix_fallocate(3). Возможные значения: none, prealloc, falloc. По умолчанию: prealloc

--hash-check-only[=true|false]

Если задано true, то после проверки хэша, используя параметр --check-integrity, загрузка прервётся, в любом случае загрузка завершится. По умолчанию: false

--human-readable[=true|false]

Выводить на консоль размеры и скорость в удобочитаемом формате (например, 1.2Ки, 3.4Ми). По умолчанию: true

--interface=<INTERFACE>

Привязать сокеты к заданному интерфейсу. Вы можете указать имя интерфейса, IP-адрес и имя хоста. Возможные значения: имя интерфейса (например, eth0), IP-адрес (например, 192.168.0.12), имя хоста (например, myhost).

Note

Если интерфейс имеет несколько адресов, то настоятельно рекомендуется указать IP-адрес явно. Смотрите также --disable-ipv6. Если ваша система не имеет getifaddrs(3), это параметр не принимает имя интерфейса.

--max-download-result=<NUM>

Задать максимальное количество результатов загрузок, которые находятся в памяти. Результаты загрузок - завершенные/ошибка/удаленные загрузки. Результаты загрузок хранятся FIFO очереди, в которой может хранится NUM результатов загрузок. Когда очередь заполнена и появляется новый результат загрузки, то старейший результат загрузки удаляется из начала очереди, а новый добавляется в конец. Указание большого числа в этом параметре может привести к высокому потреблению памяти после тысяч загрузок. Значение 0 отключит сохранение результата загрузки. По умолчанию: 1000

--max-resume-failure-tries=<N>

Если параметр --always-resume=false, aria2 загрузит файл с нуля, при обнаружении N -го URI, не поддерживающего возобновление. Если N =``0``, то aria2 загрузит файл с нуля, когда все URI не поддерживают возобновление. Смотрите параметр --always-resume. По умолчанию: 0

--log-level=<LEVEL>

Задать уровень вывода журнала событий. LEVEL может быть: debug, info, notice, warn или error. По умолчанию: debug

--on-bt-download-complete=<COMMAND>

Для BitTorrent, в --on-download-complete указывается команда, которая вызывается после завершение загрузки и окончания сидирования. С другой стороны, этот параметр определяет команду, которая будет выполнена после завершения загрузки, но до сидирования. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Возможные значения: /путь/к/команде

--on-download-complete=<COMMAND>

Задать команду, которая будет выполнена после завершения загрузки. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Смотрите также параметр --on-download-stop. Возможные значения: /путь/к/команде

--on-download-error=<COMMAND>

Задать команду, которая будет выполнена после того, как загрузка будет прервана из-за ошибки. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Смотрите также параметр --on-download-stop. Возможные значения: /путь/к/команде

--on-download-pause=<COMMAND>

Задать команду, которая будет выполнена после того, как загрузка будет приостановлена. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Возможные значения: /путь/к/команде

--on-download-start=<COMMAND>

Задать команду, которая будет выполнена после того, как началась загрузка. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Возможные значения: /путь/к/команде

--on-download-stop=<COMMAND>

Задать команду, которая будет выполнена после того, как загрузка остановлена. Вы можете изменить команду, которая будет выполнятся при определенном результате загрузки, используя параметры --on-download-complete и --on-download-error. Если они указаны, то команда, определенная в этом параметре не будет выполнятся. Смотрите раздел Перехват сообщения для более подробной информации о COMMAND. Возможные значения: /путь/к/команде

--piece-length=<LENGTH>

Задать длину блока для HTTP/FTP-загрузок. Это является границей, когда aria2 разделяет файл на части. Все разделения происходят многократно по этой длине. Этот параметр будет игнорироваться при BitTorrent-загрузках. Также будет игнорироваться, если Metalink-файл содержит хэши блоков. По умолчанию: 1M

Note

Возможный вариант использования параметра --piece-length - изменение диапазона запроса в одном конвейерном HTTP-запросе. Для включения конвейерной обработки HTTP используйте --enable-http-pipelining.

--show-console-readout[=true|false]

Показывать консольный вывод. По умолчанию: true

--summary-interval=<SEC>

Задать интервал в секундах до вывода сообщения о прогрессе загрузки. Установка 0 запрещает вывод. По умолчанию: 60

Note

В загрузках многофайлового торрента, по определенным смежным файлам также, которые размещены в части одного блока.

-Z, --force-sequential[=true|false]

Получить URI в последовательности командной строки и загрузить каждое URI в отдельной сессии, как в обычных утилитах загрузки командной строки. По умолчанию: false

--max-overall-download-limit=<SPEED>

Задать максимальную общую скорость загрузки в байтах/сек. 0 значит неограниченно. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Чтобы ограничить скорость загрузки для узла, используйте параметр --max-download-limit. По умолчанию: 0

--max-download-limit=<SPEED>

Установить максимальную скорость каждого узла загрузки в байтах/сек. 0 значит неограниченно. Вы можете добавить K или M (1K = 1024, 1M = 1024K). Чтобы ограничить общую скорость загрузки, используйте параметр --max-overall-download-limit. По умолчанию: 0

--no-conf[=true|false]

Отключить загрузку файла aria2.conf.

--no-file-allocation-limit=<SIZE>

Не резервируется место для файлов, размер которых меньше SIZE. Вы можете добавить K или M (1K = 1024, 1M = 1024K). По умолчанию: 5M

-P, --parameterized-uri[=true|false]

Включить поддержку параметризованных URI. Вы можете указать набор частей: http://{sv1,sv2,sv3}/foo.iso. Также вы можете указать числовую последовательность с шагом счетчика: http://host/image[000-100:2].img. Шагом счетчика можно пренебречь. Если все URI не указывают на такой же файл, как во втором приведенном выше примере, то необходим параметр -Z. По умолчанию: false

-q, --quiet[=true|false]

Сделать aria2 молчаливой (без консольного вывода). По умолчанию: false

--realtime-chunk-checksum[=true|false]

Подтверждать правильность блока данных путем вычисления контрольной суммы во время загрузки файла, если предусмотрена контрольная сумма блоков. По умолчанию: true

--remove-control-file[=true|false]

Удалять контрольный файл перед загрузкой. При использовании с --allow-overwrite=true файл всегда загружается с нуля. Это может понадобиться пользователям за прокси-сервером, не поддерживающим возобновление загрузки.

--save-session=<FILE>

Сохранять ошибочные/незаконченные загрузки в FILE при выходе. Вы можете передать этот выходной файл aria2c с параметром --input-file при перезапуске. Обратите внимание, что загрузки, добавленные через RPC-методы aria2.addTorrent(), aria2.addMetalink() и чьи метаданные не могут быть сохранены как файл, не будут сохраняться. Загрузки, удаленные с использованием aria2.remove() и aria2.forceRemove() не будут сохранены.

--stop=<SEC>

Останавливать программу после того как пройдет SEC секунд. Если задано 0, эта возможность будет отключена. По умолчанию: 0

--stop-with-process=<PID>

Остановить приложение, когда процесс с идентификационный номером PID не работает. Это полезно, если процесс aria2 запущен из родительского процесса. Родительский процесс может запустить aria2 со своим идентификационным номером и когда он (процесс) завершиться по какой-то причине, aria2 может обнаружить это и самостоятельно завершиться.

--truncate-console-readout[=true|false]

Укорачивать консольный вывод, чтобы он поместился в одну строку. По умолчанию: true

-v, --version

Вывести номер версии, информацию об авторских правах, конфигурации и выйти.

0

Если все загрузки завершились успешно.

1

Если произошла неизвестная ошибка.

2

Если время истекло.

3

Если ресурс не был найден.

4

Если aria2 получила определенное число ошибок "ресурс не найден". Смотрите параметр --max-file-not-found.

5

Если загрузка прервана, поскольку скорость загрузки была слишком медленной. Смотрите параметр --lowest-speed-limit.

6

Если произошла проблема с сетью.

7

Если были не завершенные загрузки. Эта ошибка только появляется, только если все завершенные загрузки были успешны и были не завершенные загрузки в очереди, когда aria2 завершилась по нажатию Ctrl-C пользователем или при отправке сигнала TERM или INT.

8

Если удаленный сервер не поддерживает возобновление, когда оно было указано как обязательное для завершения загрузки.

9

Если было не достаточно доступного места на диске.

10

Если размер блока был отличным от указанного контрольном файле --allow-piece-length-change.

11

Если aria2 был загружен один и тот же файл в тот момент.

12

Если aria2 загрузила торрент с одним и тем же хэшем в этот момент.

13

Если файл уже существует. Смотрите параметр --allow-overwrite.

14

Если не удалось переименование. Смотрите параметр --auto-file-renaming.

15

Если aria2 не смогла открыть существующий файл.

16

Если aria2 не смогла создать новый файл или обрезать существующий файл.

17

Если произошла ошибка чтения/записи файла.

18

Если aria2 не смогла создать каталог.

19

Если не удалось разрешение имен (DNS).

20

Если aria2 не смогла проанализировать Metalink-документ.

21

Если FTP-команда не удалась.

22

Если HTTP-заголовок ответа был испорчен или неожиданным.

23

Если произошло слишком много перенаправлений.

24

Если HTTP-авторизация не удалась.

25

Если aria2 не смогла проанализировать закодированный файл (обычно

26

Если файл .torrent был испорчен или потеряна информация, которая необходима aria2.

27

Если Magnet-ссылка была плохой.

28

Если был задан плохой/неопознанный параметр или неожиданный аргумент к нему.

29

Если удаленный сервер не смог обработать запрос из-за временной перегрузки или регламентных работ.

30

Если aria2 не смогла проанализировать JSON-RPC-запрос.

http_proxy [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]

Указать прокси-сервер для использования в HTTP. Заменяет значение http-proxy в конфигурационном файле. Параметр --http-proxy в командной строке заменяет эту переменную.

https_proxy [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]

Указать прокси-сервер для использования в HTTPS. Заменяет значение https-proxy в конфигурационном файле. Параметр --https-proxy в командной строке заменяет эту переменную.

ftp_proxy [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]

Указать прокси-сервер для использования в FTP. Заменяет значение ftp-proxy в конфигурационном файле. Параметр --ftp-proxy в командной строке заменяет эту переменную.

all_proxy [http://][ПОЛЬЗОВАТЕЛЬ:ПАРОЛЬ@]ХОСТ[:ПОРТ]

Указать прокси-сервер для использования, если не указан конкретный протокол для прокси. Заменяет значение all-proxy в конфигурационном файле. Параметр --all-proxy в командной строке заменяет эту переменную.

no_proxy [ДОМЕН,...]

Указать, разделенные запятыми, имена хостов, доменов и сетевых адресов с CIDR-блоком, или без него, для которых прокси использоваться не будет. Заменяет значение no-proxy в конфигурационном файле. Параметр --no-proxy в командной строке заменяет эту переменную.

host

Хост-имя сервера. Обязательно.

protocol

Протокол для этого профиля, такие как ftp, http. Обязательно.

dl_speed

Средняя скорость загрузки, которая наблюдалась при предыдущей загрузке, в байт/секунду. Обязательно.

sc_avg_speed

Средняя скорость загрузки, которая наблюдалась при предыдущей загрузке, в байт/секунду. Это значение обновляется, только если загрузка произведена при одном соединении и только с использованием AdaptiveURISelector. Необязательно.

mc_avg_speed

Средняя скорость загрузки, которая наблюдалась при предыдущей загрузке, в байт/секунду. Это значение обновляется, только если загрузка произведена при нескольких соединениях и только с использованием AdaptiveURISelector. Необязательно.

counter

Сколько раз использовался сервер. В настоящее время это значение используется только при AdaptiveURISelector. Необязательно.

last_updated

Время связи, в GMT, с этим сервером, указывается в секундах, начиная с 00:00:00 1 Января, 1970, UTC. Обязательно.

status

ERROR, когда сервер не доступен из-за неисправности или тайм-аута. Иначе - OK.

GID

GID (или gid) - это ключ, для управления каждой загрузкой. Каждая загрузка имеет уникальный GID. В настоящее время GID представлен как целое число, но обрабатывается как не целое число, т.к. он может быть изменен на другой тип в будущих версиях. Обратите внимание, что GID существует в локальной сессии и не сохраняется при завершении работы aria2.

aria2.addUri(uris[, options[, position]])

Этот метод добавляет новый HTTP(S)/FTP/BitTorrent Magnet URI. Параметр uris имеет тип массив, элемент которого имеет тип строка и содержит URI. Для BitTorrent Magnet URI, uris должен содержать только один элемент, и он должен быть BitTorrent Magnet URI. URI в параметре uris должны указывать на один и тот же файл. Если вы смешивайте другие URI, указывающие на другой файл, то aria2 не сообщит об этом, но и загрузка может неудачно завершаться. Параметр options имеет тип структура, элементы которой являются парой имя и значение. Смотрите ниже Параметры для более подробной информации. Если параметр position задан как целое число, начиная с 0, то новая загрузка будет вставлена на позицию position в очередь ожидания. Если параметр position не задан или больше чем размер очереди, то загрузка будет добавлена в конец очереди. Этот метод возвращает GID зарегистрированной загрузки.

 

Пример JSON-RPC

 

Следующий пример добавляет http://example.org/file в aria2:

 

>>> import urllib2, json
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.addUri',
...                       'params':[['http://example.org/file']]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> c.read()
'{"id":"qwer","jsonrpc":"2.0","result":"1"}'
    

 

Пример XML-RPC

 

Следующий пример добавляет http://example.org/file в aria2:

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.addUri(['http://example.org/file'])
'1'
    

 

Следующий пример добавляет два источника и некоторые параметры:

 

>>> s.aria2.addUri(['http://example.org/file', 'http://mirror/file'],
                    dict(dir="/tmp"))
'2'
    

 

Следующий пример добавляет загрузку и вставляет ее перед ожидающими загрузками:

 

>>> s.aria2.addUri(['http://example.org/file'], {}, 0)
'3'
    

aria2.addTorrent(torrent[, uris[, options[, position]]])

Этот метод добавляет BitTorrent-загрузку путем загрузки .torrent-файла. Если вы хотите добавить BitTorrent Magnet URI, взамен используйте метод aria2.addUri(). Параметр torrent имеет тип base64, с содержанием Base64-кодировки Параметр uris используется для Web-сидирования. Для однофайловых торрентов, URI может быть завершенным, который указывает на ресурс, или же если заканчиваться символом /, тогда будет добавлено имя из torrent-файла. Для многофайловых торентов, имя и путь в торренте будут добавлены из URI для каждого файла. Параметр options имеет тип структура, элементы которой являются парой имя и значение. Смотрите ниже Параметры для более подробной информации. Если параметр position задан как целое число, начиная с 0, то новая загрузка будет вставлена на позицию position в очередь ожидания. Если параметр position не задан или больше чем размер очереди, то загрузка будет добавлена в конец очереди. Этот метод возвращает GID зарегистрированной загрузки. Загруженные данные сохраняются в файл с именем шестнадцатеричной строки SHA-1-хэша этих данных плюс ".torrent", в каталог указанный в параметре --dir. Например, имя файла 0a3893293e27ac0490424c06de4d09242215f0a6.torrent. Если этот файл существует, то он будет перезаписан. Если файл не может быть успешно сохранен, то загрузки, добавленные этим методом, не сохраняются при помощи параметра --save-session.

 

Пример JSON-RPC

 

Следующий пример добавляет локальный файл file.torrent в aria2:

 

>>> import urllib2, json, base64
>>> torrent = base64.b64encode(open('file.torrent').read())
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'asdf',
...                       'method':'aria2.addTorrent', 'params':[torrent]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> c.read()
'{"id":"asdf","jsonrpc":"2.0","result":"6"}'
    

 

Пример XML-RPC

 

Следующий пример добавляет локальный файл file.torrent в aria2:

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.addTorrent(xmlrpclib.Binary(open('file.torrent').read()))
'6'
    

aria2.addMetalink(metalink[, options[, position]])

Этот метод добавляет Metalink-загрузку путем загрузки Base64-кодировки в .metalink-файле. Параметр options имеет тип структура, элементы которой являются парой имя-значение. Смотрите ниже Параметры для более подробной информации. Если параметр position задан как целое число, начиная с 0, то новая загрузка будет вставлена на позицию position в очередь ожидания. Если параметр position не задан или больше чем размер очереди, то загрузка будет добавлена в конец очереди. Этот метод возвращает GID зарегистрированной загрузки. Загруженные данные сохраняются в файл с именем шестнадцатеричной строки SHA-1-хэша этих данных плюс ".metalink", в каталог указанный в параметре --dir. Например, имя файла 0a3893293e27ac0490424c06de4d09242215f0a6.metalink. Если этот файл существует, то он будет перезаписан. Если файл не может быть успешно сохранен, то загрузки, добавленные этим методом, не сохраняются при помощи параметра --save-session.

 

Пример JSON-RPC

 

Следующий пример добавляет локальный файл file.meta4 в aria2:

 

>>> import urllib2, json, base64
>>> metalink = base64.b64encode(open('file.meta4').read())
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.addMetalink', 'params':[metalink]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> c.read()
'{"id":"qwer","jsonrpc":"2.0","result":["8"]}'
    

 

Пример XML-RPC

 

Следующий пример добавляет локальный файл file.meta4 в aria2:

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.addMetalink(xmlrpclib.Binary(open('file.meta4').read()))
['8']
    

aria2.remove(gid)

Этот метод удаляет загрузку, которая обозначена gid. Параметр gid имеет тип строка. Если указана загрузка, которая загружается в данный момент, то сначала она остановится. Статус удаления станет "removed" (удаленно). Этот метод возвращает GID удаленной загрузки.

 

Пример JSON-RPC

 

Следующий пример удаляет загрузку, GID которой "3":

 

>>> import urllib2, json
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.remove', 'params':['3']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> c.read()
'{"id":"qwer","jsonrpc":"2.0","result":"3"}'
    

 

Пример XML-RPC

 

Следующий пример удаляет загрузку, GID которой "3":

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.remove('3')
'3'
    

aria2.forceRemove(gid)

Этот метод удаляет загрузку, которая обозначена gid. Метод действует подобно aria2.remove(), за исключением того, что метод удаляет загрузку без каких-либо действий, которые требует времени, например связь с BitTorrent-трекером.

aria2.pause(gid)

Этот метод приостанавливает загрузку, которая обозначена gid. Параметр gid имеет тип строки. Статус приостановки станет "paused" (приостановлено). Если загрузка активна, то загрузка переместится на первую позицию в очередь ожидания. Пока статус "paused", загрузка не начнется. Для смены статуса на "waiting", используйте метод aria2.unpause(). Этот метод возвращает GID приостановленной загрузки.

aria2.pauseAll()

Этот метод эквивалентен по вызову aria2.pause(), для каждой активной/ожидающей закачки. Этот метод возвращает "OK", в случае успеха.

aria2.forcePause(pid)

Этот метод приостанавливает загрузку, которая обозначена gid. Метод действует подобно aria2.pause(), за исключением того, что метод приостанавливает загрузку без каких-либо действий, которые требует времени, например связь с BitTorrent-трекером.

aria2.forcePauseAll()

Этот метод эквивалентен по вызову aria2.forcePause(), для каждой активной/ожидающей закачки. Этот метод возвращает "OK", в случае успеха.

aria2.unpause(gid)

Этот метод изменяет статус загрузки, которая обозначена 'gid', с "paused" на "waiting". Это позволяет перезапускать загрузку. Значение ключа gid имеет тип строки. Этот метод возвращает GID, снятой с паузы, загрузки.

aria2.unpauseAll()

Этот метод эквивалентен по вызову aria2.unpause(), для каждой активной/ожидающей закачки. Этот метод возвращает "OK", в случае успеха.

aria2.tellStatus(gid[, keys])

Этот метод возвращает состояние загрузки, которая обозначена gid. Параметр gid имеет тип строка. Параметр keys имеет тип массив строк. Если keys указан, то ответ содержит определенные значения в массиве keys. Если keys пустой или не указан, то ответ содержит все значения. Это полезно, если вы хотите использовать определенные параметры, чтобы исключить множество пересылок. Например, aria2.tellStatus("1", ["gid", "status"]) возвратит gid и 'status'. Ответ имеет тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.tellStatus', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'bitfield': u'0000000000',
             u'completedLength': u'901120',
             u'connections': u'1',
             u'dir': u'/downloads',
             u'downloadSpeed': u'15158',
             u'files': [{u'index': u'1',
                         u'length': u'34896138',
                         u'completedLength': u'34896138',
                         u'path': u'/downloads/file',
                         u'selected': u'true',
                         u'uris': [{u'status': u'used',
                                    u'uri': u'http://example.org/file'}]}],
             u'gid': u'1',
             u'numPieces': u'34',
             u'pieceLength': u'1048576',
             u'status': u'active',
             u'totalLength': u'34896138',
             u'uploadLength': u'0',
             u'uploadSpeed': u'0'}}

>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.tellStatus',
...                       'params':['1', ['gid',
...                                       'totalLength',
...                                       'completedLength']]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'completedLength': u'5701632',
             u'gid': u'1',
             u'totalLength': u'34896138'}}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.tellStatus('1')
>>> pprint(r)
{'bitfield': 'ffff80',
 'completedLength': '34896138',
 'connections': '0',
 'dir': '/downloads',
 'downloadSpeed': '0',
 'errorCode': '0',
 'files': [{'index': '1',
            'length': '34896138',
            'completedLength': '34896138',
            'path': '/downloads/file',
            'selected': 'true',
            'uris': [{'status': 'used',
                      'uri': 'http://example.org/file'}]}],
 'gid': '1',
 'numPieces': '17',
 'pieceLength': '2097152',
 'status': 'complete',
 'totalLength': '34896138',
 'uploadLength': '0',
 'uploadSpeed': '0'}

>>> r = s.aria2.tellStatus('1', ['gid', 'totalLength', 'completedLength'])
>>> pprint(r)
{'completedLength': '34896138', 'gid': '1', 'totalLength': '34896138'}

aria2.getUris(gid)

Этот метод возвращает URI, используемые в загрузке, которая обозначена gid. Параметр gid имеет тип строка. Ответ имеет тип массив, а элемент - тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getUris', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': [{u'status': u'used',
              u'uri': u'http://example.org/file'}]}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getUris('1')
>>> pprint(r)
[{'status': 'used', 'uri': 'http://example.org/file'}]

aria2.getFiles(gid)

Этот метод возвращает список файлов загрузки, которая обозначена gid. Параметр gid имеет тип строка. Ответ имеет тип массив, а элемент - тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getFiles', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': [{u'index': u'1',
              u'length': u'34896138',
              u'completedLength': u'34896138',
              u'path': u'/downloads/file',
              u'selected': u'true',
              u'uris': [{u'status': u'used',
                         u'uri': u'http://example.org/file'}]}]}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getFiles('1')
>>> pprint(r)
[{'index': '1',
  'length': '34896138',
  'completedLength': '34896138',
  'path': '/downloads/file',
  'selected': 'true',
  'uris': [{'status': 'used',
            'uri': 'http://example.org/file'}]}]

aria2.getPeers(gid)

Этот метод возвращает список пиров загрузки, которая обозначена gid. Параметр gid имеет тип строка. Этот метод только для BitTorrent. Ответ имеет тип массив, а элемент - тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getPeers', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': [{u'amChoking': u'true',
              u'bitfield': u'ffffffffffffffffffffffffffffffffffffffff',
              u'downloadSpeed': u'10602',
              u'ip': u'10.0.0.9',
              u'peerChoking': u'false',
              u'peerId': u'aria2%2F1%2E10%2E5%2D%87%2A%EDz%2F%F7%E6',
              u'port': u'6881',
              u'seeder': u'true',
              u'uploadSpeed': u'0'},
             {u'amChoking': u'false',
              u'bitfield': u'ffffeff0fffffffbfffffff9fffffcfff7f4ffff',
              u'downloadSpeed': u'8654',
              u'ip': u'10.0.0.30',
              u'peerChoking': u'false',
              u'peerId': u'bittorrent client758',
              u'port': u'37842',
              u'seeder': u'false',
              u'uploadSpeed': u'6890'}]}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getPeers('1')
>>> pprint(r)
[{'amChoking': 'true',
  'bitfield': 'ffffffffffffffffffffffffffffffffffffffff',
  'downloadSpeed': '10602',
  'ip': '10.0.0.9',
  'peerChoking': 'false',
  'peerId': 'aria2%2F1%2E10%2E5%2D%87%2A%EDz%2F%F7%E6',
  'port': '6881',
  'seeder': 'true',
  'uploadSpeed': '0'},
 {'amChoking': 'false',
  'bitfield': 'ffffeff0fffffffbfffffff9fffffcfff7f4ffff',
  'downloadSpeed': '8654',
  'ip': '10.0.0.30',
  'peerChoking': 'false',
  'peerId': 'bittorrent client758',
  'port': '37842',
  'seeder': 'false,
  'uploadSpeed': '6890'}]

aria2.getServers(gid)

Этот метод возвращает текущие подключенные HTTP(S)/FTP-серверы загрузки, которая обозначена gid. Параметр gid имеет тип строка. Ответ имеет тип массив, а элемент - тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getServers', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': [{u'index': u'1',
              u'servers': [{u'currentUri': u'http://example.org/file',
                            u'downloadSpeed': u'10467',
                            u'uri': u'http://example.org/file'}]}]}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getServers('1')
>>> pprint(r)
[{'index': '1',
  'servers': [{'currentUri': 'http://example.org/dl/file',
               'downloadSpeed': '20285',
               'uri': 'http://example.org/file'}]}]

aria2.tellActive([keys])

Этот метод возвращает список активных загрузок. Ответ имеет тип массив и его элемент такая же структура, которая возвращается методом aria2.tellStatus(). За разъяснениями о параметре 'keys', обратитесь к методу aria2.tellStatus().

aria2.tellWaiting(offset, num[, keys])

Этот метод возвращает список ожидающих загрузок, включая приостановленные загрузки. offset имеет целочисленный тип и указывает смещение, начиная от ожидающей загрузки. num имеет целочисленный тип и указывает число возвращаемых загрузок. За разъяснениями о параметре 'keys', обратитесь к методу aria2.tellStatus().

 

Если смещение положительное целое число, то этот метод возвращает загрузки в диапазоне [ offset, offset*+*num).

 

offset может быть отрицательным целым числом. offset == -1 указывает на последнею загрузку, которая ожидает в очереди, а offset == -2 указывает на загрузку перед последней, и так далее. Загрузки в ответе находятся в обратном порядке.

 

Например, допустим, что есть три загрузки "A","B" и "C", в этом порядке, которые ожидают. aria2.tellWaiting(0, 1) возвратит ["A"]. aria2.tellWaiting(1, 2) возвратит ["B", "C"]. aria2.tellWaiting(-1, 2) возвратит ["C", "B"].

 

Ответ имеет тип массив и его элемент такая же структура, которая возвращается методом aria2.tellStatus().

aria2.tellStopped(offset, num[, keys])

Этот метод возвращает список остановленных загрузок. offset имеет целочисленный тип и указывает смещение, начиная с самой старой загрузки. num имеет целочисленный тип и указывает число возвращаемых загрузок. За разъяснениями о параметре 'keys', обратитесь к методу aria2.tellStatus().

 

offset и num имеют такую же семантику, как и в методе aria2.tellWaiting().

 

Ответ имеет тип массив и его элемент такая же структура, которая возвращается методом aria2.tellStatus().

aria2.changePosition(gid, pos, how)

Этот метод меняет позицию загрузки, которая обозначена gid. pos имеет целочисленный тип. how имеет тип строка. Если how - "POS_SET", то это переместит загрузку на позицию, относительно начала очереди. Если how - "POS_CUR", это переместит загрузку на позицию, относительно текущей позиции. Если how - "POS_END", это переместит загрузку на позицию, относительно конца очереди. Если целевая позиция меньше чем 0 или за пределами конца очереди, это переместит загрузку в начало или конец очереди соответственно. Ответ имеет целочисленный тип и является целевой позицией.

 

Например, если GID#1 размещается на позиции 3, aria2.changePosition('1', -1, 'POS_CUR') изменит его позицию на 2. Дополнительно aria2.changePosition('1', 0, 'POS_SET') изменит его позицию на 0 (начало очереди).

 

Пример JSON-RPC

 

Следующий пример перемещает загрузку, GID которой "3", в начало очереди ожидания:

 

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.changePosition',
...                       'params':['3', 0, 'POS_SET']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': 0}
    

 

Пример XML-RPC

 

Следующий пример перемещает загрузку, GID которой "3", в начало очереди ожидания:

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.changePosition('3', 0, 'POS_SET')
0
    

aria2.changeUri(gid, fileIndex, delUris, addUris[, position])

Этот метод удаляет URI в delUris из загрузки и добавляет URI в addUris к загрузке, которая обозначена gid. delUris и addUris являются списком строк. Загрузка может содержать несколько файлов и URI прилагаются к каждому файлу. fileIndex используется, чтобы выбрать файл для удаления/подключения заданных URI. fileIndex начинается с 1. position используется для указания, куда будут вставлены URI в существующем списке ожидающих URI. position начинается с 0. Когда position пропущено, URI добавляются в конец списка. Этот метод сначала выполняет удаление, а потом добавление. position это позиция после URI, которые будут удалены, а не позиция, когда метод вызывается. При удалении URI, если одинаковые URI существуют в загрузке, только один из них будет удален, для каждого URI в delUris. Другими словами, есть три URI http://example.org/aria2 и вы хотите удалить их все, вы должны указать (по крайней мере) 3 http://example.org/aria2 в delUris. Этот метод возвращает список, который содержит 2 целых числа. Первое - количество удаленных URI. Второе - количество добавленных URI.

 

Пример JSON-RPC

 

Следующий пример добавляет 1 URI http://example.org/file к файлу с индексом "1", принадлежащий загрузке, GID которой "2":

 

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.changeUri',
...                       'params':['2', 1, [], ['http://example.org/file']]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': [0, 1]}
    

 

Пример XML-RPC

 

Следующий пример добавляет 1 URI http://example.org/file к файлу с индексом "1", принадлежащий загрузке, GID которой "2":

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.changeUri('2', 1, [], ['http://example.org/file'])
[0, 1]
    

aria2.getOption(gid)

Этот метод возвращает параметры загрузки, которая обозначена gid. Ответ имеет тип структура. Ее поля - это название параметра. Поле имеет тип строка. Обратите внимание, что этот метод не возвращает параметры, которые не имеют значение по умолчанию и не были заданы параметрами командной строки, конфигурационными файлами или RPC-методами.

 

Пример JSON-RPC

 

Следующий пример получает параметры загрузки, GID которой "1":

 

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getOption', 'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'allow-overwrite': u'false',
             u'allow-piece-length-change': u'false',
             u'always-resume': u'true',
             u'async-dns': u'true',
 ...
    

 

Пример XML-RPC

 

Следующий пример получает параметры загрузки, GID которой "1":

 

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getOption('1')
>>> pprint(r)
{'allow-overwrite': 'false',
 'allow-piece-length-change': 'false',
 'always-resume': 'true',
 'async-dns': 'true',
 ....
    

aria2.changeOption(gid, options)

Этот метод изменяет динамически параметры загрузки, которая обозначена gid. gid имеет тип строка. options имеет тип структура. Доступны следующие параметры для активных загрузок:

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.changeOption',
...                       'params':['1', {'max-download-limit':'10K'}]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': u'OK'}

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.changeOption('1', {'max-download-limit':'20K'})
'OK'

aria2.getGlobalOption()

Этот метод возвращает глобальные параметры. Ответ имеет тип структура. Ее поля - это название параметра. Поле имеет тип строка. Обратите внимание, что этот метод не возвращает параметры, которые не имеют значение по умолчанию и не были заданы параметрами командной строки, конфигурационными файлами или RPC-методами. Так как глобальные параметры используются в качестве шаблона для вновь добавляемой загрузки, ответ содержит поля возвращаемые методом aria2.getOption().

aria2.changeGlobalOption(options)

Этот метод изменяет динамически глобальные параметры. options имеет тип структура. Доступны следующие параметры:

aria2.getGlobalStat()

Этот метод возвращает глобальную статистику по скорости загрузки и скорости отдачи. Ответ имеет тип структура и содержит следующие поля. Поле имеет тип строка.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getGlobalStat'})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'downloadSpeed': u'21846',
             u'numActive': u'2',
             u'numStopped': u'0',
             u'numWaiting': u'0',
             u'uploadSpeed': u'0'}}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getGlobalStat()
>>> pprint(r)
{'downloadSpeed': '23136',
 'numActive': '2',
 'numStopped': '0',
 'numWaiting': '0',
 'uploadSpeed': '0'}

aria2.purgeDownloadResult()

Этот метод очищает, для освобождения памяти, завершенные/ошибка/удаленные загрузки. Метод возвращает "OK".

aria2.removeDownloadResult(gid)

Этот метод удаляет из памяти завершенную/ошибка/удаленную загрузку, которая обозначена gid. Метод возвращает "OK", в случае успеха.

 

Пример JSON-RPC

 

Следующий пример удаляет результат загрузки, GID которой "1":

 

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.removeDownloadResult',
...                       'params':['1']})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': u'OK'}
    

 

Пример XML-RPC

 

Следующий пример удаляет результат загрузки, GID которой "1":

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.removeDownloadResult('1')
'OK'
    

aria2.getVersion()

Этот метод возвращает версию программы и список включенных возможностей. Ответ имеет тип структура и содержит следующие поля.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getVersion'})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'enabledFeatures': [u'Async DNS',
                                  u'BitTorrent',
                                  u'Firefox3 Cookie',
                                  u'GZip',
                                  u'HTTPS',
                                  u'Message Digest',
                                  u'Metalink',
                                  u'XML-RPC'],
             u'version': u'1.11.0'}}

>>> import xmlrpclib
>>> from pprint import pprint
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> r = s.aria2.getVersion()
>>> pprint(r)
{'enabledFeatures': ['Async DNS',
                     'BitTorrent',
                     'Firefox3 Cookie',
                     'GZip',
                     'HTTPS',
                     'Message Digest',
                     'Metalink',
                     'XML-RPC'],
 'version': '1.11.0'}

aria2.getSessionInfo()

Этот метод возвращает информацию о сессии. Ответ имеет тип структура и содержит следующие поля.

>>> import urllib2, json
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.getSessionInfo'})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer',
 u'jsonrpc': u'2.0',
 u'result': {u'sessionId': u'cd6a3bc6a1de28eb5bfa181e5f6b916d44af31a9'}}

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> s.aria2.getSessionInfo()
{'sessionId': 'cd6a3bc6a1de28eb5bfa181e5f6b916d44af31a9'}

aria2.shutdown()

Этот метод закрывает aria2. Метод возвращает "OK".

aria2.forceShutdown()

Этот метод закрывает aria2. Метод действует подобно aria2.shutdown(), за исключением того, что метод выполняется без каких-либо действий, которые требует времени, связь с BitTorrent-трекером пропускается. Метод возвращает "OK".

system.multicall(methods)

Этот метод объединяет несколько вызовов методов в один запрос. methods имеет тип массив, а элемент является структурой. Структура содержит два поля: methodName и params. methodName - это имя вызываемого метода, а params - содержит параметры к методу. Метод возвращает массив ответов. Элемент массива будет одним из двух: массивом из одного элемента, который содержит возвращаемое значение, для каждого вызываемого метода или структурой с ошибками в полях, если вызов объединенного метода завершился неудачно.

 

Пример JSON-RPC

 

В следующем примере мы добавляем 2 загрузки. Первая - http://example.org/file и вторая - один file.torrent:

 

>>> import urllib2, json, base64
>>> from pprint import pprint
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'system.multicall',
...                       'params':[[{'methodName':'aria2.addUri',
...                                   'params':[['http://example.org']]},
...                                  {'methodName':'aria2.addTorrent',
...                                   'params':[base64.b64encode(open('file.torrent').read())]}]]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': [[u'1'], [u'2']]}
    

 

JSON-RPC также поддерживает пакетный запрос, который описывается в спецификации JSON-RPC 2.0:

 

>>> jsonreq = json.dumps([{'jsonrpc':'2.0', 'id':'qwer',
...                        'method':'aria2.addUri',
...                        'params':[['http://example.org']]},
...                       {'jsonrpc':'2.0', 'id':'asdf',
...                        'method':'aria2.addTorrent',
...                        'params':[base64.b64encode(open('file.torrent').read())]}])
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> pprint(json.loads(c.read()))
[{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': u'1'},
 {u'id': u'asdf', u'jsonrpc': u'2.0', u'result': u'2'}]
    

 

Пример XML-RPC

 

В следующем примере мы добавляем 2 загрузки. Первая - http://example.org/file и вторая - один file.torrent:

 

>>> import xmlrpclib
>>> s = xmlrpclib.ServerProxy('http://localhost:6800/rpc')
>>> mc = xmlrpclib.MultiCall(s)
>>> mc.aria2.addUri(['http://example.org/file'])
>>> mc.aria2.addTorrent(xmlrpclib.Binary(open('file.torrent').read()))
>>> r = mc()
>>> tuple(r)
('2', '3')
    

aria2.onDownloadStart(event)

Это уведомление будет оправлено, если загрузка запущена. Параметр event имеет тип структура и содержит следующие поля. Поле имеет тип строка.

aria2.onDownloadPause(event)

Это уведомление будет оправлено, если загрузка приостановлена. event - такая же структура, как параметр event в методе aria2.onDownloadStart().

aria2.onDownloadStop(event)

Это уведомление будет оправлено, если загрузка остановлена пользователем. event - такая же структура, как параметр event в методе aria2.onDownloadStart().

aria2.onDownloadComplete(event)

Это уведомление будет оправлено, если загрузка завершена. В BitTorrent-загрузках, это уведомление отправляется, когда загрузка завершена и сидирование окончено. event - такая же структура, как параметр event в методе aria2.onDownloadStart().

aria2.onDownloadError(event)

Это уведомление будет оправлено, если загрузка остановлена из-за ошибки. event - такая же структура, как параметр event в методе aria2.onDownloadStart().

aria2.onBtDownloadComplete(event)

Это уведомление будет оправлено, если загрузка в BitTorrent завершена (но сидирование может быть не окончено). event - такая же структура, как параметр event в методе aria2.onDownloadStart().