獲取對象列表
更新時間 2023-12-14 13:18:42
最近更新時間: 2023-12-14 13:18:42
分享文章
接口介紹
該API 作用為列出存儲桶(Bucket)中所有對象(Object)的信息。
接口約束
無
請求URI
GET /v1/{bucket}
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名稱。 | testBucket |
Query參數
無
請求參數
請求頭header參數
無
請求體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 |
表 Owner
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ID | String | 用戶id。 | User1 | |
| DisplayName | String | 對象昵稱。 | User1-Disp |
請求示例
GET /v1/testbucket
請求頭header
Host: gdoss.xstore.daliqc.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="//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>
</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>
</Contents>
</ListBucketResult>
狀態碼
| 狀態碼 | 錯誤碼 | 描述 |
|---|---|---|
| 200 | 操作成功。 | |
| 403 | AccessDenied | 用戶沒有權限執行操作。 |
| 404 | NoSuchBucket | 操作指定的桶不存在。 |
