接口介绍
列出请求用户拥有的所有的Bucket列表。
接口约束
支持的线上资源池 :上海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 | 332232eb-63aa-465e-9028-52e5123866f0 |
projectID | 否 | String | 桶所属的企业项目。如有多个,使用逗号分隔;若不传此参数,将使用当前账号所有有权限的企业项目 | 12334378,345987,476343 |
pageSize | 否 | Integer | 页大小,默认值 10,取值范围 1~50 | 3 |
pageNo | 否 | Integer | 页码,默认值 1 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
returnObj | Object | 响应对象 | 见下级对象 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
bucketList | Array of Objects | 桶数组 | 见下级对象 |
bucketTotal | Integer | 总记录数 | 23 |
pageSize | Integer | 页大小 | 3 |
pageNo | Integer | 页码 | 1 |
totalCount | Integer | 总记录数 | 23 |
currentCount | Integer | 当前页记录数 | 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 |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/list-buckets?pageNo=1&pageSize=3regionID=332232eb-63aa-465e-9028-52e5123866f0
响应示例
{
"returnObj": {
"bucketTotal": 23,
"bucketList": [
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"bucket": "bucket-20230322-1",
"isEncrypted": false,
"AZPolicy": "single-az",
"creationDate": "2023-03-22T02:27:55Z"
},
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"bucket": "bucket-20230322-2",
"isEncrypted": false,
"AZPolicy": "single-az",
"creationDate": "2023-03-22T06:52:11Z"
},
{
"cmkUUID": "",
"storageType": "STANDARD",
"projectID": "0",
"bucket": "bucket-20230322-3",
"isEncrypted": false,
"AZPolicy": "single-az",
"creationDate": "2023-03-22T06:52:16Z"
}
],
"pageSize": 3,
"pageNo": 1,
"totalCount": 23,
"currentCount": 3
},
"message": "SUCCESS",
"statusCode": 800,
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表