Enumerate Buckets
Last Updated：2021-09-13
Interface Description
This interface lists all buckets owned by the requester.
Notes
- When no user verification information is available in the request, this interface returns the
403 Forbiddenwith the error information:AccessDenied.- The naming convention of the JSON request response item is the lower camel case.
- In a request, it can return the information of up to 100 buckets.
Request URI
GET /v1
Request Body Parameters
Instructions for Data Structure of Request Body Field
Response Body Parameters
Instructions for Data Structure of Response Body Field
| Parameter Name | Parameter Type | Description | Example Value |
|---|---|---|---|
| owner | Owner | Bucket owner information | |
| buckets | List |
Container for storing the information of multiple buckets |
Data Structure Description of Owner Field
| Parameter Name | Parameter Type | Description | Example Value |
|---|---|---|---|
| id | String | Bucket owner ID | 10eb6f5ff6ff4605bf044313e8f3ffa5 |
| displayName | String | Name of the bucket owner | BosUser |
Data Structure Description of Buckets Field
| Parameter Name | Parameter Type | Description | Example Value |
|---|---|---|---|
| name | String | Bucket name | bucket2 |
| location | String | The region where the bucket resides. | bj |
| creationDate | String | Bucket creation date | 2016-04-05T16:41:58Z |
| enableMultiAz | Boolean | Whether the bucket data is distributed in multiple AZs. If it is a non-multi-AZ bucket, do not return this attribute. | true |
Request Example
GET /v1
Common Request Header
{ }Response Example
HTTP/1.1 200 OK
<Common response header>
{
"owner" : {
"displayName" : "BosUser",
"id" : "10eb6f5ff6ff4605bf044313e8f3ffa5"
},
"buckets" : [ {
"name" : "bucket2",
"location" : "bj",
"creationDate" : "2016-04-05T16:41:58Z"
"enableMultiAz" : true
}, {
"name" : "bucket2",
"location" : "bj",
"creationDate" : "2016-04-05T16:41:58Z",
"enableMultiAz" : true
} ]
}Error Code
Refer to the universal error code.