You need to enable JavaScript to run this app.
Torch Object Storage

Torch Object Storage

  • Documentation
    • Torch Object StorageSDK ReferenceJavaBucket InterfaceBasic Bucket InterfaceListing Buckets (Java SDK)
Copy page
Download PDF
Basic Bucket Interface
Listing Buckets (Java SDK)
Copy page
Download PDF
Listing Buckets (Java SDK)
A bucket (Bucket) is the globally unique namespace in TOS, serving as a data container for storing object (Object) data. This article describes how to use the TOS Java SDK listBuckets interface to enumerate the list of buckets across all regions under your account.​
Category​
  • Before listing buckets, you must have the tos:ListBuckets permission. For detailed instructions, refer to IAM Policy Overview.​
  • This interface returns all buckets across all regions for the current account.​
Sample Code​
The following code demonstrates how to list all buckets across all regions for the current account.​
​
import com.volcengine.tos.TOSV2;​
import com.volcengine.tos.TOSV2ClientBuilder;​
import com.volcengine.tos.TosClientException;​
import com.volcengine.tos.TosServerException;​
import com.volcengine.tos.model.bucket.ListBucketsV2Input;​
import com.volcengine.tos.model.bucket.ListBucketsV2Output;​
import com.volcengine.tos.model.bucket.ListedBucket;​
​
public class ListBucketExample {​
public static void main(String[] args) {​
String endpoint = "your endpoint";​
String region = "your region";​
String accessKey = System.getenv("TOS_ACCESS_KEY");​
String secretKey = System.getenv("TOS_SECRET_KEY");​
​
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);​
​
try{​
ListBucketsV2Input input = new ListBucketsV2Input();​
ListBucketsV2Output output = tos.listBuckets(input);​
System.out.println("bucket owner is " + output.getOwner());​
if (output.getBuckets() != null) {​
System.out.println("you have listed " + output.getBuckets().size() + " buckets");​
for (int i = 0; i < output.getBuckets().size(); i++){​
ListedBucket bucket = output.getBuckets().get(i);​
System.out.printf("Listed bucket, name is %s, location is %s, extranetEndpoint is %s, " +​
"intranetEndpoint is %s, creationDate is %s.\n", bucket.getName(), bucket.getLocation(),​
bucket.getExtranetEndpoint(), bucket.getIntranetEndpoint(), bucket.getCreationDate());​
}​
} else {​
System.out.println("there are no buckets in your account.");​
}​
} catch (TosClientException e) {​
System.out.println("listBuckets failed");​
System.out.println("Message: " + e.getMessage());​
if (e.getCause() != null) {​
e.getCause().printStackTrace();​
}​
} catch (TosServerException e) {​
System.out.println("listBuckets failed");​
System.out.println("StatusCode: " + e.getStatusCode());​
System.out.println("Code: " + e.getCode());​
System.out.println("Message: " + e.getMessage());​
System.out.println("RequestID: " + e.getRequestID());​
} catch (Throwable t) {​
System.out.println("listBuckets failed");​
System.out.println("unexpected exception, message: " + t.getMessage());​
}​
}​
}​
​
Related documentation​
For API documentation on listing buckets, refer to ListBuckets.​
Last updated: 2025.09.19 20:00:28