List Buckets
Updated at：2025-11-03
API description
This API lists all buckets owned by the requester
Note
- If the request lacks user authentication (i.e., anonymous access), it returns
403 Forbiddenwith the error message:AccessDenied.- JSON request and response items follow the camelcase naming convention with the first letter in lowercase.
- A single request can return details of up to 100 buckets.
Request URI
GET /v1
Parameters of request body
Description of the data structure of request body fields
Response body parameters
Description of the data structure of response body fields
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| owner | Owner | Bucket owner information | |
| buckets | List |
Container storing the information of multiple buckets |
Description of Owner field data structure
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| id | String | User ID of bucket owner | 10eb6f5ff6ff4605bf044313e8f3ffa5 |
| displayName | String | The name of the bucket owner | BosUser |
Description of Buckets field data structure
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| name | String | Bucket name | bucket2 |
| location | String | Region where the bucket is located | bj |
| creationDate | String | Bucket creation time | 2016-04-05T16:41:58Z |
| enableMultiAz | Boolean | Whether the bucket data is multi-AZ distributed. If it is not multi-AZ bucket, the attribute is not returned. | true |
Request example
JSON
1GET /v1
2 <Common request headers>
3{ }Response example
JSON
1HTTP/1.1 200 OK
2 <Common response headers>
3{
4 "owner" : {
5 "displayName" : "BosUser",
6 "id" : "10eb6f5ff6ff4605bf044313e8f3ffa5"
7 },
8 "buckets" : [ {
9 "name" : "bucket2",
10 "location" : "bj",
11 "creationDate" : "2016-04-05T16:41:58Z",
12 "enableMultiAz" : true
13 }, {
14 "name" : "bucket2",
15 "location" : "bj",
16 "creationDate" : "2016-04-05T16:41:58Z",
17 "enableMultiAz" : true
18 } ]
19}Error code
Please refer to the general error codes