获得桶中所有对象信息(ListObjects)

获得桶内中所有对象的信息

此 GET 操作可以列出存储桶内部分或全部的对象（Object）。此 API 接口调用者需要对该存储桶有 Read 权限。

请求

请求语法

内容

  GET /  HTTP/1.1
  Host: {BucketName}.{Endpoint}
  Date: {date}
  Authorization: {SignatureValue}

描述

  Endpoint：参考与region地域的关系
  SignatureValue：参考签名算法

请求参数

名称	类型	是否必须	描述
delimiter	字符串	否	分隔符，即对object名字进行分组的字符。从指定的前缀prefix到第一次出现delimiter字符之间的内容作为一组元素（即CommonPrefixes）。默认值: 无
encoding-type	字符串	否	对返回的内容进行编码并指定编码的类型。object key 可以包含任意Unicode字符，但是XML 1.0解析器无法解析某些字符，如ASCII码中的0到10。对于这些不能被解析的字符可以添加到请求中，OSS会在响应中对他们进行编码。默认值: 无
marker	字符串	否	列举存储桶内对象的起始位置。默认值: 无
max-keys	字符串	否	设置响应体中返回的最大记录数（最后实际返回可能小于该值），最大值为1000。如果需要列举第1000条以后的桶，可以设定 marker 的值来调整起始位置。默认值: 1000
prefix	字符串	否	限定返回文件的Key必须以Prefix作为前缀。如果把prefix设为某个文件夹名，就可以列举以此Prefix开头的文件，即该文件夹下递归的所有文件和子文件夹。在设置prefix的基础上增加设置delimiter为正斜线（/）时，返回值就只列举该文件夹下的文件，文件夹下的子文件夹名返回在CommonPrefixes中，子文件夹下递归的所有文件和文件夹不显示。例如，一个Bucket中有三个object ，分别为dir/test.txt、 dir/movie/1.avi和dir/movie/7.avi。若设定Prefix为dir/，则返回三个Object；如果增加设定Delimiter为正斜线（/），则返回dir/test.txt和dir/movie/。默认值: 无
filterKey	字符串	否	对象名称过滤关键词，当对象名称中包含此关键词时才会被列举出。默认值：无

非公共请求头

无
请求体

无

响应

非公共响应头

无
响应体

名称	类型	描述
ListBucketResult	容器	保存请求结果的容器。子节点：Name, Prefix, Marker,MaxKeys, Delimiter, IsTruncated, Nextmarker, Contents
Name	字符串	存储桶的名称。父节点: ListBucketResult
Prefix	字符串	该list请求时指定key的前缀。父节点: ListBucketResult
FilterKey	字符串	该list请求时指定key的过滤关键词。当请求的url中包含关键词"filterKey"时,返回此参数，否则不返回。父节点: ListBucketResult
Marker	字符串	列举存储桶内对象的起始位置，从给定的 marker 开始返回列表。父节点: ListBucketResult
MaxKeys	字符串	指定返回Object的最大数量。默认为1000。类型: String 父节点: ListBucketResult
IsTruncated	枚举字符串	请求中返回的结果是否被截断。有效值：true表示本次没有返回全部结果，false表示本次已经返回了全部结果。父节点: ListBucketResult
Contents	容器	每一个Object的元数据。父节点: ListBucketResult
Key	字符串	Object的名称。父节点: ListBucketResult.Contents
LastModified	时间	最后一次被改动的时间。父节点: ListBucketResult.Contents
ETag	字符串	ETag (entity tag) 在每个Object生成的时候被创建，用于标示一个Object的内容。对于PutObject请求创建的Object，ETag值是其内容的MD5值；对于其他方式创建的Object，ETag值是其内容的UUID。ETag值可以用于检查Object内容是否发生变化。不建议用户使用ETag来作为Object内容的MD5校验数据完整性。父节点: ListBucketResult.Contents
Size	字符串	Object的大小，按字节统计。父节点: ListBucketResult.Contents
StorageClass	字符串	Object的存储类型，包括： STANDARD 父节点: ListBucketResult.Contents
Owner	字符串	存储桶拥有者信息。子节点: DisplayName, ID 父节点: ListBucketResult.Contents
ID	字符串	存储桶拥有者的用户ID。父节点: ListBucketResult.Contents.Owner
DisplayName	字符串	Object拥有者的名称。父节点: ListBucketResult.Contents.Owner
CommonPrefixes	字符串	如果请求中指定了delimiter参数，则在OSS返回的响应中包含CommonPrefixes元素。该元素标明那些以delimiter结尾，并有共同前缀的object名称的集合。父节点: ListBucketResult
Delimiter	字符串	对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现Delimiter字符之间的Object作为一组元素CommonPrefixes。父节点: ListBucketResult
NextMarker	字符串	本次列举没有返回全部结果时，会标记列表被截(IsTruncated=true)，同时返回最后一个object的名称，即NextMarker，可以使用NextMarker作为下次list的marker参数。父节点: ListBucketResult
Encoding-Type	字符串	指明了返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，会对返回结果中的Delimiter、Marker、Prefix、NextMarker和Key这些元素进行编码。父节点: ListBucketResult

示例

请求

  GET / HTTP/1.1
  Host: oss-example.oss-cn-beijing.inspurcloud.com
  Date: Wed, 12 Oct 2009 17:50:00 GMT
  Authorization: authorization string

响应

  <?xml version="1.0" encoding="UTF-8"?>
  <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
      <Name>oss-example</Name>
      <Prefix></Prefix>
      <FilterKey>jpg</FilterKey>
      <Marker></Marker>
      <MaxKeys>1000</MaxKeys>
      <IsTruncated>false</IsTruncated>
      <Contents>
          <Key>my-image.jpg</Key>
          <LastModified>2009-10-12T17:50:30.000Z</LastModified>
          <ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>
          <Size>434234</Size>
          <StorageClass>STANDARD</StorageClass>
          <Owner>
              <ID>67891234</ID>
              <DisplayName>user-oss@inspur.com</DisplayName>
          </Owner>
      </Contents>
      <Contents>
             <Key>my-third-image.jpg</Key>
          <LastModified>2009-10-12T17:50:30.000Z</LastModified>
          <ETag>&quot;1b2cf535f27731c974343645a3985328&quot;</ETag>
          <Size>64994</Size>
          <StorageClass>STANDARD</StorageClass>
          <Owner>
              <ID>67891234</ID>
              <DisplayName>user-oss@inspur.com</DisplayName>
          </Owner>
      </Contents>
  </ListBucketResult>

错误码

错误码	描述	状态码	描述
...	...	...	...