接口介绍
查询某个地域下所有桶的信息。
接口约束
支持的线上资源池 ：上海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 https://zos-global.ctapi.ctyun.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 枚举值，见错误码总表
