获取Bucket列表
更新时间:2022-08-24
接口描述
本接口用于获取Bucket列表。
请求结构
Plain Text
1GET /v1/bos/bucket?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&order={order}&orderBy={orderBy}®ion={region} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
pageNo | int | 否 | RequestParam参数 | 页码编号 |
pageSize | int | 否 | RequestParam参数 | 页码大小 |
keyword | String | 否 | RequestParam参数 | 关键词 |
keywordType | String | 否 | RequestParam参数 | 关键词类型,目前支持:bucketName、region、serviceProvider、city、node,node类型对应的keyword格式为:region#serviceProvider#city |
order | String | 否 | RequestParam参数 | 排序方式,默认降序 |
orderBy | String | 否 | RequestParam参数 | 排序依据,默认为创建时间 |
region | String | 否 | RequestParam参数 | 区域 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List<BucketBriefVo> | Bucket列表。 |
orderBy | String | 排序依据,默认为创建时间。 |
order | String | 排序,默认降序 |
pageNo | int | 页码编号 |
pageSize | int | 页码大小 |
totalCount | int | 总页数 |
错误码
请参照错误返回章节的内容。
请求示例
JSON
1GET https://bec.baidubce.com/v1/bos/bucket?pageNo=1&pageSize=100&keywordType=EAST_CHINA#CHINA_UNICOM#XIAN&keyword=&order=desc&orderBy=createTime®ion=EAST_CHINA
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
JSON
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6{
7 "result": [
8 {
9 "bucketId": "bkt-5f3wybgn",
10 "bucketName": "abc-test15",
11 "nodeVo": {
12 "region": "EAST_CHINA",
13 "serviceProvider": "CHINA_UNICOM",
14 "city": "XIAN"
15 },
16 "bucketEndpoint": "http://10.190.77.32:8080",
17 "maxCapacity": 0,
18 "currentUsage": 0.000000,
19 "authority": "PRIVATE",
20 "fileNum": 0,
21 "storageClass": "STANDARD",
22 "createTime": "2020-04-29 19:35:04",
23 "expireTime": null,
24 "label": null
25 },
26 {
27 "bucketId": "bkt-vdncteis",
28 "bucketName": "abc-test10",
29 "nodeVo": {
30 "region": "EAST_CHINA",
31 "serviceProvider": "CHINA_UNICOM",
32 "city": "XIAN"
33 },
34 "bucketEndpoint": "http://10.190.77.32:8080",
35 "maxCapacity": 0,
36 "currentUsage": 0.631109,
37 "authority": "PRIVATE",
38 "fileNum": 3,
39 "storageClass": "STANDARD",
40 "createTime": "2020-04-24 11:43:58",
41 "expireTime": null,
42 "label": null
43 },
44 {
45 "bucketId": "bkt-xvvyi4ti",
46 "bucketName": "abc-test9",
47 "nodeVo": {
48 "region": "EAST_CHINA",
49 "serviceProvider": "CHINA_UNICOM",
50 "city": "XIAN"
51 },
52 "bucketEndpoint": "http://10.190.77.32:8080",
53 "maxCapacity": 0,
54 "currentUsage": 0.000270,
55 "authority": "PUBLIC_READ",
56 "fileNum": 10,
57 "storageClass": "STANDARD",
58 "createTime": "2020-04-24 11:43:04",
59 "expireTime": null,
60 "label": null
61 },
62 {
63 "bucketId": "bkt-tonbqcvh",
64 "bucketName": "abc-test2",
65 "nodeVo": {
66 "region": "EAST_CHINA",
67 "serviceProvider": "CHINA_UNICOM",
68 "city": "XIAN"
69 },
70 "bucketEndpoint": "http://10.190.77.32:8080",
71 "maxCapacity": 0,
72 "currentUsage": 0.000140,
73 "authority": "PUBLIC_READ",
74 "fileNum": 14,
75 "storageClass": "STANDARD",
76 "createTime": "2020-04-24 11:42:36",
77 "expireTime": null,
78 "label": null
79 }
80 ],
81 "orders": null,
82 "orderBy": "createTime",
83 "order": "desc",
84 "pageNo": 1,
85 "pageSize": 100,
86 "totalCount": 4
87}
Model
BucketBriefVo
参数名称 | 类型 | 描述 |
---|---|---|
bucketId | String | id,全局唯一,由系统随机生成 |
bucketName | String | 名称,每个集群下唯一 |
nodeVo | NodeVo | 节点信息 |
bucketEndpoint | String | 存储的Endpoint |
maxCapacity | long | 最大容量 |
currentUsage | BigDecimal | 目前用量 |
authority | String | 权限 |
fileNum | long | 文件数量 |
storageClass | String | 存储方式 |
createTime | Date | 创建时间 |
expireTime | Date | 过期时间 |
label | String | 标签 |
nodeStr | String | 节点信息拼接成字符串 |
usageStr | String | 将用量转换为字符串 |
NodeVo
参数名称 | 类型 | 描述 |
---|---|---|
region | String | 区域 |
regionName | String | 对应区域中文名称 |
serviceProvider | String | 设备提供商 |
spName | String | 设备提供商中文名称 |
city | String | 城市 |
cityName | String | 城市中文名称 |
country | String | 国家 |
countryName | String | 国家中文名称 |