GetBucket_API_Object Storage-文档中心

列举指定空间的对象列表，需要IAM的 wos:GetBucket 权限。

请求语法

GET /?prefix=Prefix&marker=Marker&max-keys=Max-Keys&delimiter=Delimiter&start-time=Start-Time&end-time=End-Time
Host: BucketName.Endpoint
Date: Date
Authorization: <Authorization>

请求参数

参数名称	是否必填	描述	类型
prefix	否	列举以指定字符串 prefix 开头的对象。可通过前缀将空间对象分组，类似文件系统中的文件夹。	字符串
marker	否	指定从该标识符之后开始列举，对象按字典序排序。	字符串
max-keys	否	返回的最大对象数量，返回的对象列表将是按照字典顺序的最多前max-keys个对象，范围为 [1, 1000]，超出则按默认的 1000 处理。	整型
delimiter	否	用来指定将对象名按照特定字符分割的分割符。如果指定了prefix参数，按delimiter对所有对象命名进行分割，多个对象分割后prefix到第一个delimiter间都相同的对象会形成一条CommonPrefixes；如果没有携带prefix参数，按delimiter对所有对象命名进行分割，多个对象分割后从对象名开始到第一个delimiter之间相同的部分形成一条CommonPrefixes。	字符串

备注：参数名区分大小写。例如：设置 PREFIX=abc，虽然参与鉴权但实际不会生效。

请求头

仅需使用公共请求头。

请求体

无

响应语法

HTTP/1.1 StatusCode 
x-wos-request-id: RequestId 
Date: Date
Content-Type: type
Content-Length: length
Server: WS-web-server

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="https://www.wangsu.com/document">
<ListBucketResult>
  <IsTruncated>boolean</IsTruncated>
  <Marker>string</Marker>
  <NextMarker>string</NextMarker>
  <Contents>
    <ETag>string</ETag>
    <Key>string</Key>
    <LastModified>timestamp</LastModified>
    <ExpirationDate>timestamp</ExpirationDate>
    <Owner>
      <DisplayName>string</DisplayName>
      <ID>string</ID>
    </Owner>
    <Size>integer</Size>
    <StorageClass>string</StorageClass>
  </Contents>
  ...
  <Name>string</Name>
  <Prefix>string</Prefix>
  <Delimiter>string</Delimiter>
  <MaxKeys>integer</MaxKeys>
  <CommonPrefixes>
  <Prefix>string</Prefix>
  </CommonPrefixes>
  ...
  <EncodingType>string</EncodingType>
</ListBucketResult>

响应头

仅需使用公共响应头。

响应主体

该请求的响应消息中，会以XML形式将用户拥有的空间列出来，元素的具体含义如下表所示。

元素名称	描述	类型	父节点
ListBucketResult	空间内对象列表。	XML	-
Contents	对象的元数据信息。	XML	ListBucketResult
CommonPrefixes	delimiter 参数下的对象分组，以 delimiter 结尾的具有相同 Prefix 的对象将被归为一组。	XML	ListBucketResult
Delimiter	请求中携带的 delimiter 参数。	字符串	ListBucketResult
ETag	对象的 base64 编码的 128 位 MD5 摘要，用作内容唯一标识。可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。实际的ETag是对象的哈希值，ETag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，通过MD5加密后都有唯一的ETag。	字符串	ListBucketResult.Contents
ID	对象拥有者的用户ID。	字符串	ListBucketResult.Contents.Owner
DisplayName	对象拥有者的用户名。	字符串	ListBucketResult.Contents.Owner
IsTruncated	是否截断本次结果列表。`true` 表示未返回全部结果，`false` 表示返回全部结果。	Boolean	ListBucketResult
Key	对象名。	字符串	ListBucketResult.Contents
LastModified	对象最近一次被修改的时间。	Date	ListBucketResult.Contents
Marker	列举对象时的起始位置。	字符串	ListBucketResult
NextMarker	本次未返回全部结果时，用于标记最后一个对象，后续请求可用作 `marker`来列举剩余的对象。	字符串	ListBucketResult
MaxKeys	最多返回的对象数量。	字符串	ListBucketResult
Name	空间名称。	字符串	ListBucketResult
Owner	用户信息，包括用户ID和用户名。	XML	ListBucketResult.Contents
Prefix	对象名前缀，仅列举匹配此前缀的对象。	字符串	ListBucketResult
Size	对象大小。	字符串	ListBucketResult.Contents
StorageClass	对象的存储类型。有效值：`STANDARD`	枚举值	ListBucketResult.Contents
ExpirationDate	文件过期时间。	Date	ListBucketResult.Contents

异常场景

Situation	HTTP Status	Error Code	Message
max-keys 为负数	400 Bad Request	InvalidArgument	max-keys cannot be negative
max-keys 为小数或超最大整型上限	400 Bad Request	InvalidArgument	Provided max-keys not an integer or within integer range

Media Delivery

Cloud Security

Web Performance

Enterprise Application

Storage

Edge Computing

Console Guide

API Docs

GetBucket

请求语法

请求参数

请求头

请求体

响应语法

响应头

响应主体

异常场景

目录