Method: Baidu::PCS::Client#list

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

#list(path, options = {}) ⇒ Hash

获取目录下的文件列表

Examples:

调用示例

client.list('apitest/movies', order: 'asc', by: 'time', limit: '2-10')

返回的原始 JSON

{
  "list": [
    {
      "fs_id": 703525418,
      "path": "/apps/Backups/apitest/movies/1.mkv",
      "ctime": 1377136220,
      "mtime": 1384493344,
      "md5": "6366d2a234e8139c63dab707ec4569c3",
      "size": 74818037,
      "isdir": 0
    }
  ],
  "request_id": 4043312670
}

:fs_id 文件或目录在PCS的临时唯一标识id
:path  文件或目录的绝对路径
:ctime 文件或目录的创建时间
:mtime 文件或目录的最后修改时间
:md5   文件的md5值
:size  文件大小(byte)
:isdir 是否是目录的标识符:“0”为文件,“1”为目录

Parameters:

  • path (String)

    需要list的目录(相对于应用的根目录)

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

    a customizable set of options

Options Hash (options):

  • :by (String)

    排序字段,缺省根据文件名排序:time(修改时间),name(文件名),size(大小,注意目录无大小)

  • :order (String)

    asc”或“desc”,缺省采用降序排序:asc(升序),desc(降序)

  • :limit (String)

    返回条目控制,参数格式为:n1-n2。返回结果集的[n1, n2)之间的条目,缺省返回所有条目;n1从0开始

Returns:

  • (Hash)

See Also:



382
383
384
385
386
387
388
# File 'lib/baidu/pcs/client.rb', line 382

def list(path, options={})
  query = { path: build_path(path) }
  query[:by]    = options[:by]    || 'name'
  query[:order] = options[:order] || 'desc'
  query[:limit] = options[:limit]
  get "#{BASE_PATH}/file", query.update(base_query 'list')
end