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

Torch Object Storage

  • Documentation
    • Torch Object StorageSDK ReferenceJavaBucket InterfaceBasic Bucket InterfaceRetrieving Bucket Metadata (Java SDK)
Copy page
Download PDF
Basic Bucket Interface
Retrieving Bucket Metadata (Java SDK)
Copy page
Download PDF
Retrieving Bucket Metadata (Java SDK)
A bucket (Bucket) is the globally unique namespace in TOS, functioning as a data container used to store object (Object) data. This article describes how to use the TOS Java SDK headBucket interface to obtain bucket metadata, including the bucket's region and storage class, as well as to determine whether the bucket exists.​
Category​
  • Before you can obtain bucket metadata, you must have the tos:HeadBucket permission. For detailed instructions, please refer to the Permission Configuration Overview.​
  • If the bucket does not exist, this interface will return a 404 error code. This interface is also commonly used to verify the existence of a bucket.​
Sample Code​
The following code demonstrates how to retrieve bucket metadata and determine whether a bucket exists.​
​
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.HeadBucketV2Input;​
import com.volcengine.tos.model.bucket.HeadBucketV2Output;​
​
public class HeadBucketExample {​
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");​
String bucketName = "your bucket name";​
​
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);​
​
try{​
HeadBucketV2Input input = new HeadBucketV2Input().setBucket(bucketName);​
HeadBucketV2Output output = tos.headBucket(input);​
System.out.println("bucket's region is " + output.getRegion());​
System.out.println("bucket's storage class is " + output.getStorageClass());​
} catch (TosClientException e) {​
System.out.println("headBucket failed");​
System.out.println("Message: " + e.getMessage());​
if (e.getCause() != null) {​
e.getCause().printStackTrace();​
}​
} catch (TosServerException e) {​
System.out.println("headBucket failed");​
System.out.println("StatusCode: " + e.getStatusCode());​
System.out.println("RequestID: " + e.getRequestID());​
} catch (Throwable t) {​
System.out.println("headBucket failed");​
System.out.println("unexpected exception, message: " + t.getMessage());​
}​
}​
}​
​
Related documentation​
For documentation on the API to obtain bucket metadata, see HeadBucket.​
Last updated: 2025.09.19 20:00:28