View bucket list
Updated at：2025-11-03
Basic workflow
- Create an instance of the BOSClient class.
- Running the BosClient.listBuckets() method returns an instance of the ListBucketsResult class.
Example code
The following code can list all buckets of a user:
Plain Text
1let listBucketResult: ListBucketsResult;
2try {
3 listBucketResult = await bosClient.listBuckets();
4 for (let bucketInfo of listBucketResult.buckets as BucketSummaryType[]) {
5 logger.info(`bucketName: ${bucketInfo.name}, location: ${bucketInfo.location}`)
6 }
7} catch (bosResponse) {
8 logger.error(`errCode: ${bosResponse.error.code}`)
9 logger.error(`requestId: ${bosResponse.error.requestId}`)
10 logger.error(`errMessage: ${bosResponse.error.message}`)
11 logger.error(`statusCode: ${bosResponse.statusCode}`)
12}Response parameters
The parameters available for calling in the parsing class returned by the listBuckets method are as follows:
| Parameters | Description |
|---|---|
| owner | Bucket owner information |
| +id | User ID of bucket owner |
| +displayName | Name of bucket owner |
| buckets | Container storing the information of multiple buckets |
| bucket | Container storing the information of a bucket |
| +name | Bucket name |
| +createDate | Bucket creation time |
| +location | Region to which a bucket belongs |