ListBucketObjects
更新时间 2026-04-10 20:06:48
最近更新时间: 2026-04-10 20:06:48
功能说明
ListBucketObjects请求列出Bucket中的对象。
请求消息样式
GET /{Bucket}?delimiter=Delimiter&marker=Marker&max-keys=MaxKeys&prefix=Prefix HTTP/1.1
Host: xxx.zos.ctyun.cn
X-Amz-Content-SHA256: Content-SHA256
X-Amz-Date: Date
Authorization: Auth String请求消息参数
| 参数名称 | 参数描述 | 类型 | 是否必须 |
|---|---|---|---|
| Bucket | 参数解释: Bucket的名称。 | String | 是 |
| delimiter | 参数解释: 对key名称进行分组的字符。 | String | 是 |
| marker | 参数解释: 列举key的起始位置,返回的列表将是以key名按照字典序排在该参数后的对象。 | String | 是 |
| max-keys | 参数解释: 本次返回keys的最大数目。 约束限制: 小于0时返回结果为0,大于1000时返回结果为1000。 取值范围: 0-1000 默认取值: 1000 | Int | 否 |
| prefix | 参数解释: 返回的key的前缀。 | String | 否 |
请求消息头
该请求使用公共的请求消息头,请参见如何调用API-构造请求-请求消息头。
请求消息元素
该请求消息中不带消息元素。
响应消息样式
HTTP/1.1 Status Code
Transfer-Encoding: chunked
x-amz-request-id: Request Id
Content-Type: application/xml
Date: Date
Connection: Keep-Alive
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<NextMarker>string</NextMarker>
<Contents>
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<Size>integer</Size>
<StorageClass>string</StorageClass>
<Type>string</Type>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
</ListBucketResult>响应消息头
该请求的响应消息使用公共的响应消息头,请参见如何调用API-响应结果-响应消息头。
响应消息元素
| 名称 | 描述 | 类型 |
|---|---|---|
| ListBucketResult | 参数解释: 返回结果的容器。 | Container |
表ListBucketResult
| 名称 | 描述 | 类型 |
|---|---|---|
| IsTruncated | 参数解释: 列表结果是否被截断。 | Boolean |
| Marker | 参数解释: 列举key的起始位置。 | String |
| NextMarker | 参数解释: 若结果被截断,则给出分页所需的Marker。 | String |
| Contents | 参数解释: 单个对象信息的容器。 | Container |
| Name | 参数解释: Bucket的名称。 | String |
| Prefix | 参数解释: 列出请求时指定的前缀。 | String |
| Delimiter | 参数解释: 列出请求时指定的路径分隔符。 | String |
| MaxKeys | 参数解释: 列出请求时指定的最大记录数。 | Long |
| CommonPrefixes | 参数解释: 在计算返回数时,所有键(最多 1000 个)汇总在一个公共前缀中计为单个返回。仅当指定分隔符时,响应才能包含 commonPrefixes。 | Container |
表Contents
| 名称 | 描述 | 类型 |
|---|---|---|
| ETag | 参数解释: 对象的Etag。 | String |
| Key | 参数解释: 对象的Key。 | String |
| LastModified | 参数解释: 对象的修改时间。 | Date |
| Owner | 参数解释: 对象所有者信息。 | Container |
| Size | 参数解释: 对象的大小。 | Long |
| StorageClass | 参数解释: 对象的存储级别。 | String |
| Type | 参数解释: 对象类型,普通对象为 | String |
表CommonPrefixes
| 名称 | 描述 | 类型 |
|---|---|---|
| Prefix | 参数解释: 对象的公共前缀。 | String |
表Owner
| 名称 | 描述 | 类型 |
|---|---|---|
| DisplayName | 参数解释: 所有者名称。 | String |
| ID | 参数解释: 所有者ID。 | String |
错误码
请参见调用前必知-错误码-全局错误码。