接口功能介绍

查询桶的基础信息和用量数据。

接口约束

支持所有一类节点资源池。

URI

GET /v4/oss/get-bucket-info

路径参数 无

Query参数

请求参数

请求头header参数 无

请求体body参数 无

响应参数

枚举参数

无

请求示例

请求url

GET https://zos-global.ctapi.ctyun.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
}

状态码

请参考 状态码

错误码

请参考 错误码