查詢所有桶
更新時間 2025-06-11 14:55:17
最近更新時間: 2025-06-11 14:55:17
分享文章
接口介紹
查詢某個地域下所有桶的信息。
接口約束
支持的線上資源池 :上海7、南京3、南京5、杭州2、合肥2、九江、廣州6、武漢4、福州25、廈門3、郴州2、海口2、北京5、雄安2、石家莊20、內蒙6、晉中、遼陽1、西安5、烏魯木齊4、烏魯木齊27、中衛5、蘭州2、西寧2、拉薩3、昆明2、重慶2、成都4、貴州3、上海33、寧波邊緣云、華東1、上海36、南昌5、青島20、武漢41、長沙42、長沙37、南寧23、北京行業云20、華北2、西南1、上海32。
URI
GET /v4/oss/list-buckets
請求參數
請求 Query 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 區域 ID,將返回對應區域下的桶。若需要返回所有公共資源池的桶,請傳入 public。 | public |
| projectID | 否 | String | 桶所屬的企業項目。如有多個,使用逗號分隔;若不傳此參數,將使用當前賬號所有有權限的企業項目 | 12334378,345987,476343 |
| pageSize | 否 | Long | 頁大小,默認值 10,取值范圍 1~50 | 3 |
| pageNo | 否 | Long | 頁碼,默認值 1 | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Long | 返回狀態碼(800為成功,900為處理中/失敗) | 800 | |
| message | String | 狀態描述 | SUCCESS | |
| description | String | 狀態描述,一般為中文 | 成功 | |
| returnObj | Object | 響應對象 | returnObj | |
| errorCode | String | 業務細分碼(僅失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed | |
| error | String | 業務細分碼(大駝峰形式,僅失敗時具有此參數),為 Product.Module.Code 三段式碼 | Openapi.UserPermission.AccessFailed |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| bucketList | Array of Objects | 桶數組 | bucketList | |
| bucketTotal | Long | 總記錄數 | 23 | |
| pageSize | Long | 頁大小 | 3 | |
| pageNo | Long | 頁碼 | 1 | |
| totalCount | Long | 總記錄數 | 23 | |
| currentCount | Long | 當前頁記錄數 | 3 |
表 bucketList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| creationDate | String | 創建日期,為 ISO 8601 格式 | 2022-10-18T02:24:40Z | |
| cmkUUID | String | 加密ID,若 isEncrypted 為 false,此值為空字符串 "" | wasgdfeb-63aa-465e-9028-52e5123866f0 | |
| storageType | String | 存儲類型,可選的值為 STANDARD, STANDARD_IA, GLACIER | STANDARD | |
| projectID | String | 企業項目 ID | 12334378 | |
| bucket | String | 桶名 | bucket-2222 | |
| isEncrypted | Boolean | 是否加密 | true | |
| AZPolicy | String | AZ策略,single-az 或 multi-az | single-az | |
| regionName | String | 區域名稱 | 貴州2 | |
| regionID | String | 區域ID | ec51e2b21942466b896fe22147d8fe73 |
請求示例
GET //zos-global.ctapi.daliqc.cn/v4/oss/list-buckets?regionID=332232eb-63aa-465e-9028-52e5123866f0&pageNo=1&pageSize=3
響應示例
{
"returnObj": {
"bucketTotal": 23,
"bucketList": [
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"regionID": "ec51e2b21942466b896fe22147d8fe73",
"bucket": "bucket-a80e",
"isEncrypted": false,
"AZPolicy": "single-az",
"creationDate": "2023-09-08T10:49:11Z",
"regionName": "貴州2"
},
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"regionID": "ec51e2b21942466b896fe22147d8fe73",
"bucket": "bucket-e9ae",
"isEncrypted": false,
"AZPolicy": "single-az",
"creationDate": "2023-09-08T10:51:28Z",
"regionName": "貴州2"
},
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"regionID": "89f64827f25f464565ffa3a5deb5d15d",
"bucket": "bucket-2ac4",
"isEncrypted": false,
"AZPolicy": "multi-az",
"creationDate": "2023-09-08T10:51:41Z",
"regionName": "貴州1"
},
],
"pageSize": 3,
"pageNo": 1,
"totalCount": 23,
"currentCount": 3
},
"message": "SUCCESS",
"statusCode": 800,
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值,見錯誤碼總表