查詢桶信息
更新時間 2025-10-15 18:59:25
最近更新時間: 2025-10-15 18:59:25
分享文章
接口功能介紹
查詢桶的基礎信息和用量數據。
接口約束
支持所有一類節點資源池。
URI
GET /v4/oss/get-bucket-info
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| bucket | 是 | String | 存儲桶名 | bucket1 | |
| regionID | 是 | String | 區域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
請求參數
請求頭header參數 無
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| projectID | String | 企業項目 ID | 0 | |
| cmkUUID | String | kms加密ID,若此值為null,則表示未開啟加密 | wasgdfeb-63aa-465e-9028-52e5123866f0 | |
| storageType | String | 存儲類型,可選的值為 STANDARD, STANDARD_IA, GLACIER | STANDARD | |
| AZPolicy | String | AZ策略,single-az 或 multi-az | single-az | |
| bucketQuota | Object | 桶配額 | bucketQuota | |
| tenant | String | 租戶信息 | xxx | |
| ctime | String | 桶的創建時間 | 2023-03-22 02:27:55.288026Z | |
| bucketPreviewFlag | Long | 桶是否支持文件預覽 | 0 | |
| placementRule | String | placement規則名 | default-placement | |
| mtime | String | 桶的最后修改時間 | 2023-03-22 02:27:55.387103Z | |
| bucket | String | 桶名 | bucket-20230322-1 | |
| owner | String | 所屬用戶uid | 6b670413-5ebf-593a-a985-76d598374df7 | |
| usage | Object | 使用信息 | usage | |
| numShards | Long | 分片數量 | 0 | |
| tagMap | Object | 鍵值對形式的桶標簽集 | ||
| indexType | String | 索引類型 | Normal | |
| explicitPlacement | Object | 顯示設置placement | explicitPlacement | |
| zonegroup | String | zone組 | 34c6f6cb-fd52-4676-b7d2-0e799a644bb7 | |
| 表 bucketQuota |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| enabled | Boolean | 是否開啟 | false | |
| maxSize | Long | 最大容量,單位byte,未設置時默認為-1 | -1 | |
| maxObjects | Long | 最大對象數,未設置時默認為-1 | -1 | |
| checkOnRaw | Boolean | 是否使用原始對象大小進行配額檢查 | false | |
| maxSizeKb | Long | 最大容量,單位kb | 0 | |
| 表 usage |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| sizeKbUtilized | Long | 已使用容量,單位kb | 140 | |
| sizeActual | Long | 實際使用容量,單位byte | 143360 | |
| sizeKbActual | Long | 實際使用容量,單位kb | 140 | |
| sizeKb | Long | 容量,單位kb | 140 | |
| storageTypeIa | Object | 低頻用量 | storageTypeIa | |
| numObjects | Long | 對象數量 | 33 | |
| earlydelGlacierSize | Long | 提前刪除歸檔類型數據量 | 0 | |
| storageTypeGlacier | Object | 歸檔用量 | storageTypeGlacier | |
| storageTypeStandard | Object | 標準用量 | storageTypeStandard | |
| numMultiparts | Long | 碎片數量 | 0 | |
| earlydelIaSize | Long | 提前刪除低頻類型數據量 | 0 | |
| sizeUtilized | Long | 已使用容量,單位byte | 143360 | |
| size | Long | 容量,單位byte | 143360 | |
| 表 storageTypeIa |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| sizeKbUtilized | Long | 已使用容量,單位kb | 12 | |
| sizeActual | Long | 實際使用容量,單位byte | 12288 | |
| sizeKbActual | Long | 實際使用容量,單位kb | 12 | |
| numObjects | Long | 對象數量 | 3 | |
| sizeUtilized | Long | 已使用容量,單位byte | 12288 | |
| numMultiparts | Long | 碎片數量 | 0 | |
| sizeKb | Long | 容量,單位kb | 12 | |
| size | Long | 容量,單位byte | 12288 | |
| 表 storageTypeGlacier |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| sizeKbUtilized | Long | 已使用容量,單位kb | 12 | |
| sizeActual | Long | 實際使用容量,單位byte | 12288 | |
| sizeKbActual | Long | 實際使用容量,單位kb | 12 | |
| numObjects | Long | 對象數量 | 3 | |
| sizeUtilized | Long | 已使用容量,單位byte | 12288 | |
| numMultiparts | Long | 碎片數量 | 0 | |
| sizeKb | Long | 容量,單位kb | 12 | |
| size | Long | 容量,單位byte | 12288 | |
| 表 storageTypeStandard |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| sizeKbUtilized | Long | 已使用容量,單位kb | 12 | |
| sizeActual | Long | 實際使用容量,單位byte | 12288 | |
| sizeKbActual | Long | 實際使用容量,單位kb | 12 | |
| numObjects | Long | 對象數量 | 3 | |
| sizeUtilized | Long | 已使用容量,單位byte | 12288 | |
| numMultiparts | Long | 碎片數量 | 0 | |
| sizeKb | Long | 容量,單位kb | 12 | |
| size | Long | 容量,單位byte | 12288 | |
| 表 explicitPlacement |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| dataExtraPool | String | 數據冗余池 | xxx | |
| dataPool | String | 數據池 | xxx | |
| indexPool | String | 索引池 | xxx |
枚舉參數
無
請求示例
請求url
GET //zos-global.ctapi.daliqc.cn/v4/oss/get-bucket-info?regionID=332232eb-63aa-465e-9028-52e5123866f0&bucket=bucket1
請求頭header
無
請求體body
無
響應示例
{
"returnObj": {
"projectID": "0", //企業項目 ID
"cmkUUID": "wasgdfeb-63aa-465e-9028-52e5123866f0", // kms 加密 ID,若此值為 null,則表示未開啟加密
"storageType": "STANDARD", //存儲類型,可選的值為 STANDARD, STANDARD_IA, GLACIER
"AZPolicy": "single-az", //AZ策略,single-az 或 multi-az
"bucketQuota": { //桶配額
"enabled": false, //是否開啟
"maxSize": -1, //最大容量,單位byte
"maxObjects": -1, //最大對象數
"checkOnRaw": false,
"maxSizeKb": 0 //最大容量,單位kb
},
"tenant": "",
"ctime": "2023-03-22 02:27:55.288026Z", // create time
"bucketPreviewFlag": 0, //桶是否支持文件預覽
"placementRule": "default-placement", //placement規則名
"mtime": "2023-03-22 02:27:55.387103Z", // modify time
"bucket": "bucket-20230322-1", //桶名
"owner": "6b670413-5ebf-593a-a985-76d598374df7", //所屬用戶uid
"usage": { //使用信息
"sizeKbUtilized": 140, //已使用容量,單位kb
"sizeActual": 143360, //實際使用容量,單位byte
"sizeKbActual": 140, //實際使用容量,單位kb
"sizeKb": 140, //容量,單位kb
"storageTypeIa": { //低頻用量
"sizeKbUtilized": 12, //已使用容量,單位kb
"sizeActual": 12288, //實際使用容量,單位byte
"sizeKbActual": 12, //實際使用容量,單位kb
"numObjects": 3, //對象數量
"sizeUtilized": 12288, //已使用容量,單位byte
"numMultiparts": 0, //碎片數量
"sizeKb": 12, //容量,單位kb
"size": 12288 //容量,單位byte
},
"numObjects": 33, //對象數量
"earlydelGlacierSize": 0, //提前刪除歸檔類型數據量
"storageTypeGlacier": { //歸檔用量
"sizeKbUtilized": 12, //已使用容量,單位kb
"sizeActual": 12288, //實際使用容量,單位byte
"sizeKbActual": 12, //實際使用容量,單位kb
"numObjects": 3, //對象數量
"sizeUtilized": 12288, //已使用容量,單位byte
"numMultiparts": 0, //碎片數量
"sizeKb": 12, //容量,單位kb
"size": 12288 //容量,單位byte
},
"storageTypeStandard": { //標準用量
"sizeKbUtilized": 116, //已使用容量,單位kb
"sizeActual": 118784, //實際使用容量,單位byte
"sizeKbActual": 116, //實際使用容量,單位kb
"numObjects": 27, //對象數量
"sizeUtilized": 118784, //已使用容量,單位byte
"numMultiparts": 0, //碎片數量
"sizeKb": 116, //容量,單位kb
"size": 118784 //容量,單位byte
},
"numMultiparts": 0, //碎片數量
"earlydelIaSize": 0, //提前刪除低頻類型數據量
"sizeUtilized": 143360, //已使用容量,單位byte
"size": 143360 //容量,單位byte
},
"numShards": 0, //分片數量
"tagMap":{ //桶標簽
"hello":"world",
"weare":"ctyun"
},
"indexType": "Normal",
"explicitPlacement": {
"dataExtraPool": "",
"dataPool": "",
"indexPool": ""
},
"zonegroup": "34c6f6cb-fd52-4676-b7d2-0e799a644bb7", //zone組
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
請參考
錯誤碼
請參考