Method: Baidu::PCS::Client#list_task

Defined in:
lib/baidu/pcs/client.rb

#list_task(options = {}) ⇒ Hash

查询离线下载任务列表

查询离线下载任务ID列表及任务信息

Examples:

不包含任务信息,返回的原始 JSON

{"task_info":[{"task_id":"26"}, {"task_id":"27"}],"total":"2","request_id":1283164486}

包含任务信息,返回的原始 JSON

{
  "task_info": [
    {
      "task_id": "26",
      "source_url": "https://example.com/1.dmg",
      "save_path": "/apps/album/1.dmg",
      "rate_limit": "100",
      "timeout": "10000",
      "callback": "",
      "status": "1",
      "create_time": "1347449048"
    }
  ],
  "total": "1",
  "request_id": 1285732167
}

Parameters:

  • options (Hash) (defaults to: {})

    皆为可选参数

Options Hash (options):

  • :start (Fixnum)

    查询任务起始位置,默认为0

  • :limit (Fixnum)

    设定返回任务数量,默认为10

  • :asc (Fixnum)

    0:降序;1:升序;默认为0

  • :need_task_info (Fixnum)

    是否需要返回任务信息:0:不需要;1:需要;默认为1

  • :status (Fixnum)

    任务状态

  • :create_time (Fixnum)

    任务创建时间,note:此参数似乎无效

  • :source_url (String)

    源地址URL

  • :save_path (String)

    文件保存路径(相对于应用根目录)

  • :expires (Fixnum)

    请求失效时间,如果有,则会校验

Returns:

  • (Hash)

See Also:



879
880
881
882
# File 'lib/baidu/pcs/client.rb', line 879

def list_task(options={})
  query = options.dup
  post "#{BASE_PATH}/services/cloud_dl", query.update(base_query 'list_task')
end