獲取桶信息
更新時間 2023-12-07 21:32:54
最近更新時間: 2023-12-07 21:32:54
分享文章
接口介紹
用于查看存儲空間（Bucket）的相關信息。
接口約束
無。
請求URI
GET /v1/bucketInfo/{bucket}
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名稱 | testBucket |
Query 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| bucketInfo | 是 | String | 固定參數 | - | - |
注意：如果query中的參數為固定參數，不需要帶值value。
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| BucketInfo | 是 | Array of Objects | 保存Bucket信息的容器。 | BucketInfo |
表 BucketInfo
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Bucket | 是 | Array of Objects | 保存Bucket信息的容器。 | Bucket |
表 Bucket
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| CreationDate | 是 | String | Bucket的創建時間，格式為UTC時間。 | 2013-07-31T10:56:21.000Z | |
| ExtranetEndpoint | 是 | String | Bucket的外網域名。 | oss-cn-shanghai.ctyun.1com | |
| Name | 是 | String | Bucket名稱。 | example | |
| Owner | 是 | Array of Objects | 存放Bucket擁有者信息的容器。 | Owner | |
| AccessControlList | 是 | Array of Objects | Bucket讀寫權限（ACL）信息的容器。 | AccessControlList |
表 Owner
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| ID | 是 | String | Bucket擁有者的用戶ID。 | 11111 | ｜ |
| DisplayName | 是 | String | Bucket擁有者的名稱（目前和用戶ID一致）。 | username |
表 AccessControlList
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Grant | 是 | String | Bucket的ACL權限。 | private |
請求示例
GET /v1/testBucket?bucketInfo HTTP/1.1
請求頭header
無
請求體body
無
響應示例
HTTP/1.1 200
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2015 07:51:28 GMT
Connection: keep-alive
Content-Length: 531
<?xml version="1.0" encoding="UTF-8"?>
<BucketInfo>
<Bucket>
<CreationDate>2023-04-12T04:38:15.689Z</CreationDate>
<ExtranetEndpoint>xxx.ctyun.1store</ExtranetEndpoint>
<Name>new_bucket_test</Name>
<Owner>
<ID>test</ID>
<DisplayName>test</DisplayName>
</Owner>
<AccessControlList>
<Grant>private</Grant>
</AccessControlList>
</Bucket>
</BucketInfo>
狀態碼
| 狀態碼 | 錯誤碼 | 描述 |
|---|---|---|
| 200 | 操作成功。 | |
| 403 | AccessDenied | 用戶沒有權限執行操作。 |
| 404 | NoSuchBucket | 操作指定的桶不存在。 |
