接口介绍
查询桶信息，桶创建后未上传对象时查询接口，usage字段为空。
接口约束
支持的线上资源池 ：上海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/get-bucket-info
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 存储桶名 | bucket1 |
| regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| returnObj | Object | 响应对象 | 见响应示例 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-bucket-info?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0
响应示例
{
"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
"poolKey": "PREVIOUS", //多pool关键字
"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, //分片数量
"indexType": "Normal",
"loggingTargetBucket": false,
"explicitPlacement": {
"dataExtraPool": "",
"dataPool": "",
"indexPool": ""
},
"zonegroup": "34c6f6cb-fd52-4676-b7d2-0e799a644bb7", //zone组
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
