接口功能介绍
该API 作用为列出存储桶(bucket)中所有对象(object)的信息。
接口约束
无。
URI
GET /{bucket}
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名称 | testBucket |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 用于验证请求合法性的认证信息 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ListBucketResult | Array of Objects | 对象列表的容器 | ListBucketResult |
表 ListBucketResult
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Name | String | 桶名称 | Bucket1 | |
| Prefix | String | 对象key的前缀 | ||
| Marker | String | 返回对象的起始下标 | ||
| MaxKeys | Integer | Key 数目的最大值 | 1000 | |
| Delimiter | String | 如果该参数被设置，具有相同前缀的对象将出现在CommonPrefixes列表中 | ||
| IsTruncated | Boolean | 如果值为True，仅返回桶内容的一个子集 | false | |
| Contents | Array of Objects | 对象信息 | Contents |
表 Contents
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Key | String | 对象名 | my-image.jpg | |
| LastModified | String | 最近修改时间 | 2009-10-12T17:50:30.000Z | |
| ETag | String | 对象唯一标识 | fba9dede5f27731c9771645a39863328 | |
| Size | Integer | 对象大小 | 434234 | |
| StorageClass | String | 对象存储类型 | STANDARD | |
| Owner | Array of Objects | 对象属主 | - | Owner |
| Type | String | 对象存储类型 | Normal |
表 Owner
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 用户id | User1 | |
| DisplayName | String | 对象昵称 | User1-Disp |
请求示例
GET /testbucket
请求头header
Host: gdoss.xstore.ctyun.cn
Date: Wed, 28 Oct 2023 09:32:00 GMT
Authorization: authorization string
请求体body
无
响应示例
HTTP/1.1 200 OK
x-amz-request-id: tx0000000004-006322d20c
Content-Type: application/xml
Date: Thu, 15 Sep 2022 07:19:40 GMT
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Name>testBucket</Name>
<Prefix></Prefix>
<Marker></Marker>
<MaxKeys>1000</MaxKeys>
<IsTruncated>false</IsTruncated>
<Contents>
<Key>my-image.jpg</Key>
<LastModified>2009-10-12T17:50:30.000Z</LastModified>
<ETag>"fba9dede5f27731c9771645a39863328"</ETag>
<Size>434234</Size>
<StorageClass>STANDARD</StorageClass>
<Owner>
<ID>User1</ID>
<DisplayName>User1-Disp</DisplayName>
</Owner>
<Type>Normal</Type>
</Contents>
<Contents>
<Key>my-third-image.jpg</Key>
<LastModified>2009-10-12T17:50:30.000Z</LastModified>
<ETag>"1b2cf535f27731c974343645a3985328"</ETag>
<Size>64994</Size>
<StorageClass>STANDARD</StorageClass>
<Owner>
<ID>User1</ID>
<DisplayName>User1-Disp</DisplayName>
</Owner>
<Type>Normal</Type>
</Contents>
</ListBucketResult>
状态码
| 状态码 | 错误码 | 描述 |
|---|---|---|
| 200 | 操作成功 | |
| 403 | AccessDenied | 用户没有权限执行操作 |
| 404 | NoSuchBucket | 操作指定的桶不存在 |
错误码
请参考 请求错误码（原生接口）。
