Torch Object Storage
Torch Object Storage
Torch Object Storage
Document
What's New
Announcements
Billing
Billable items
Billing method
Getting Started
User Guide
Working with buckets
Basic configurations
Managing lifecycle
Back-to-origin rules
Event notification
Intelligent Tiering
Permissions
Domain management
Fault tolerance and disaster recovery
Cross-region replication
Same-region replication
Data redundancy
Image processing
ObjectSet
Working with objects
Managing folders
Monitoring and alerting
Metric monitoring
Access control
Bucket policies
Common configuration scenarios
Authorizing IAM users of the current account
Authorizing other accounts
Managing access via tools and SDKs
Managing public read access
Data security
Access points
Multi-region access points (MRAP)
Single-region access points (SRAP)
Converged access points (CAP)
DevMind
TOS accelerator
SenseFlow
TOS Agent
Data processing
Basic concepts
Image processing
Media processing
Document preview
Task processing
Data subscription
Flow control management
Quality of Service (QoS) policies
Hierarchical namespace (HNS)
User guide
Tool reference
Best practices
TOS Vectors
User guide
API reference
Vector bucket
Vector index
SDK reference
Python-Vectors
Vector bucket
Vector index
Java-Vectors
Vector bucket
Vector index
Node.js-Vectors
Vector bucket
Vector index
Tool Guide
tosutil
Common commands
Upload, download, and copy objects
Share objects
Auxiliary commands
Common examples
TOS Browser
FSX
FSX best practices
TOS PyTorch Connector
tosfsspec
API Reference
Signature Mechanism
The header contains a signature
Bucket
Basic Bucket Operations
Bucket Lifecycle
Access Monitor
Bucket ACL
Bucket CORS
Bucket Policy
Back-to-origin Rules
Bucket Replication
Versioning
Static Website
Event Notification
Custom Domain
Server-side encryption
Transfer Acceleration
Data Processing
Image processing
Media processing
Video transcoding
Audio transcoding
video to GIF
Document preview
File decompression
Log Storage
Retention Policy
Requester pays
TLS version
Object
Basic Object Operations
Object ACL
Fetch Object
Symbolic Link
WORM object
Multipart Upload
SDK Reference
Java
Pre-signing Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload Object
Download Object
Upload and Download Speed Limit
Copy Object
List Object
Data Processing
Image Processing
Video Processing
Audio Processing
Log Configuration
Hierarchical Namespace
Bucket base interface
Introduction to Typical Scenes
Python
Data processing
Pre-signature mechanism
Bucket interface
Basic bucket interface
Manage bucket configuration
Object interface
Upload object
Download object
Copy object
List objects
Introduction to typical scenes
C
Object Interface
Upload object
C++
Pre-signature Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload Object
Download Object
Copy Object
List Objects
Data Processing
Go
Object Interface
Upload Object
Download Object
Copy Object
List Objects
Manage Objects
Bucket Interface
Manage Bucket Configuration
Data Processing
Log Configuration
Introduction to Typical Scenes
Pre-signature Mechanism
Node.js
Pre-signature Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload object
Download object
Copy object
List objects
Data Processing
Image Processing
Introduction to Typical Scenes
Browser.js
Pre-signature Mechanism
Upload Object
Download Object
Copy Object
List Objects
Manage Objects
Data Processing
.NET
Bucket Interface
Object Interface
Upload Object
Download Object
List Objects
Introduction to Typical Scenes
PHP
Bucket Interface
Object Interface
Download Object
Data Processing
Exception Handling
Android
Bucket Interface
Object Interface
Upload Object
Download Object
Exception Handling
iOS
Bucket Interface
Object Interface
Upload Object
Download Object
Harmony
Pre-signature Mechanism
Bucket Interface
Object Interface
Upload Object
Download Object
List Objects v2
Introduction to Typical Scenarios
Rust
Pre-signing mechanism
Bucket interface
Basic bucket operations
Lifecycle rules
Bucket ACLs
Cross-origin resource sharing
Bucket inventory
Back-to-origin rules
Bucket replication
Static website hosting
Event notification
Custom domain
Server-side encryption
Object interface
Basic operation
Access control
Error Codes
01-SERVICE_ERROR
02-AUTH
03-ACCESS_CONTROL
04-QOS
05-REQUEST
06-BUCKET
07-LIFECYCLE
08-ACL
09-CORS
10-POLICY
11-MIRROR
12-REPLICATION
13-WEBSITE
14-NOTIFICATION
15-ENCRYPT
16-CUSTOMDOMAIN
17-OBJECT
18-TAG
19-MULTIPART
20-STORAGE_CLASS
21-CALLBACK
22-DATA_PROCESS
23-BATCH
24-STORAGE_LENS
25-INVENTORY
26-DIRECTORY_BUCKET
FAQ
Best Practices
AIGC-Doubao LLMs
Accessing TOS with third-party tools
Granting temporary access
Data migration
Data processing
Checking data integrity
Performance optimization
- Documentation
Torch Object StorageSDK ReferenceJavaObject InterfaceUpload ObjectResumable Uploads (Java SDK)
Copy page
Download PDFUpload Object
Resumable Uploads (Java SDK)
Copy pageDownload PDFResumable Uploads (Java SDK)
The uploadFile interface of the Java SDK supports uploading large local files to TOS using resumable multipart upload. When using this interface, you can configure parameters such as chunk size, the number of concurrent threads for uploading chunks, client-side upload rate limiting, progress bar display, and event callback functions. It also supports canceling the upload task during the resumable upload process. If a network exception or similar issue causes a file upload to fail, you may invoke this interface again to resume uploading the unfinished portion from the breakpoint.
Category
- To upload objects, your account must have the tos:PutObject permission. For detailed instructions, please refer to the Permission Configuration Guide.
- When uploading an object, the object name must comply with specific requirements. For detailed information, please refer to Object Naming Specifications.
- uploadFile interface supports a maximum of 1,000 concurrent threads, with a default chunk size of 20 MiB.
- If an object with the same name already exists in the bucket, the new object will overwrite the existing one. When multi-versioning is enabled for a bucket, the original object is retained, and a new version number is generated to identify the newly uploaded object.
- TOS is a distributed object storage product designed for massive storage. Its internal partitions store object index data. To horizontally scale the maximum throughput when uploading and downloading objects, and to reduce the likelihood of hot partitions, please avoid using lexicographically incremental object naming. For more details, refer to Performance Optimization.
Basic Example
The following code demonstrates the basic usage of the uploadFile interface.
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.object.UploadFileV2Input;
import com.volcengine.tos.model.object.UploadFileV2Output;
public class UploadFileExample {
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 = "bucket-example";
String objectKey = "example_dir/example_object.txt";
String uploadFilePath = "example_dir/example_file.txt";
int taskNum = 5;
long partSize = 20 * 1024 * 1024;
boolean enableCheckpoint = true;
String checkpointFilePath = "the checkpoint file path";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
UploadFileV2Input input = new UploadFileV2Input().setBucket(bucketName).setKey(objectKey)
.setFilePath(uploadFilePath).setEnableCheckpoint(enableCheckpoint)
.setCheckpointFile(checkpointFilePath).setPartSize(partSize).setTaskNum(taskNum);
UploadFileV2Output output = tos.uploadFile(input);
System.out.println("uploadFile succeed, object's etag is " + output.getEtag());
System.out.println("uploadFile succeed, object's crc64 is " + output.getHashCrc64ecma());
} catch (TosClientException e) {
System.out.println("uploadFile failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("uploadFile 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("uploadFile failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Event Callback
The following code demonstrates how to customize a listener callback function during the resumable upload process.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.event.UploadEventType;
import com.volcengine.tos.model.object.*;
public class UploadFileWithEventListenerExample {
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 = "bucket-example";
String objectKey = "example_dir/example_object.txt";
String uploadFilePath = "example_dir/example_file.txt";
int taskNum = 5;
long partSize = 20 * 1024 * 1024;
boolean enableCheckpoint = true;
String checkpointFilePath = "the checkpoint file path";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
UploadEventListener listener = new UploadEventListener() {
@Override
public void eventChange(UploadEvent uploadEvent) {
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventCreateMultipartUploadSucceed) {
System.out.println("event change, createMultipartUpload succeed");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventCreateMultipartUploadFailed) {
System.out.println("event change, createMultipartUpload failed");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventUploadPartSucceed) {
System.out.println("event change, uploadPart succeed");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventUploadPartFailed) {
System.out.println("event change, uploadPart failed");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventUploadPartAborted) {
System.out.println("event change, uploadPart aborted");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventCompleteMultipartUploadSucceed) {
System.out.println("event change, completeMultipartUpload succeed");
}
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventCompleteMultipartUploadFailed) {
System.out.println("event change, completeMultipartUpload failed");
}
}
};
UploadFileV2Input input = new UploadFileV2Input().setBucket(bucketName).setKey(objectKey)
.setFilePath(uploadFilePath).setEnableCheckpoint(enableCheckpoint)
.setCheckpointFile(checkpointFilePath).setPartSize(partSize).setTaskNum(taskNum)
.setUploadEventListener(listener);
UploadFileV2Output output = tos.uploadFile(input);
System.out.println("uploadFile succeed, object's etag is " + output.getEtag());
System.out.println("uploadFile succeed, object's crc64 is " + output.getHashCrc64ecma());
} catch (TosClientException e) {
System.out.println("uploadFile failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("uploadFile 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("uploadFile failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Cancellation Mechanism
During the resumable upload process, the SDK supports canceling upload tasks. The following code demonstrates how to cancel an ongoing resumable upload task.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.event.UploadEventType;
import com.volcengine.tos.model.object.*;
public class UploadFileWithCancelExample {
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 = "bucket-example";
String objectKey = "example_dir/example_object.txt";
String uploadFilePath = "example_dir/example_file.txt";
int taskNum = 5;
long partSize = 20 * 1024 * 1024;
boolean enableCheckpoint = true;
String checkpointFilePath = "the checkpoint file path";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
UploadFileV2Input input = new UploadFileV2Input().setBucket(bucketName).setKey(objectKey)
.setFilePath(uploadFilePath).setEnableCheckpoint(enableCheckpoint)
.setCheckpointFile(checkpointFilePath).setPartSize(partSize).setTaskNum(taskNum);。
boolean isAbort = true;
UploadEventListener listener = new UploadEventListener() {
@Override
public void eventChange(UploadEvent uploadEvent) {
if (uploadEvent.getUploadEventType() == UploadEventType.UploadEventUploadPartFailed) {
System.out.println("event change, uploadPart failed");
if (input.getCancelHook() != null) {
input.getCancelHook().cancel(isAbort);
}
}
}
};
input.setCancelHook(true).setUploadEventListener(listener);
UploadFileV2Output output = tos.uploadFile(input);
System.out.println("uploadFile succeed, object's etag is " + output.getEtag());
System.out.println("uploadFile succeed, object's crc64 is " + output.getHashCrc64ecma());
} catch (TosClientException e) {
System.out.println("uploadFile failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("uploadFile 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("uploadFile failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Handling the progress bar during upload and configuring client-side rate limiting
The following code demonstrates how to utilize the progress bar functionality and configure upload client rate limiting.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.event.DataTransferListener;
import com.volcengine.tos.comm.event.DataTransferStatus;
import com.volcengine.tos.comm.event.DataTransferType;
import com.volcengine.tos.comm.ratelimit.RateLimiter;
import com.volcengine.tos.internal.util.ratelimit.DefaultRateLimiter;
import com.volcengine.tos.model.object.ObjectMetaRequestOptions;
import com.volcengine.tos.model.object.UploadFileV2Input;
import com.volcengine.tos.model.object.UploadFileV2Output;
import java.io.File;
public class UploadFileWithProgressAndRateLimiterExample {
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 = "bucket-example";
String objectKey = "example_dir/example_object.txt";
String uploadFilePath = "example_dir/example_file.txt";
int taskNum = 5;
long partSize = 20 * 1024 * 1024;
boolean enableCheckpoint = true;
String checkpointFilePath = "the checkpoint file path";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
UploadFileV2Input input = new UploadFileV2Input().setBucket(bucketName).setKey(objectKey)
.setFilePath(uploadFilePath).setEnableCheckpoint(enableCheckpoint)
.setCheckpointFile(checkpointFilePath).setPartSize(partSize).setTaskNum(taskNum);
ObjectMetaRequestOptions options = new ObjectMetaRequestOptions().setContentLength(new File(uploadFilePath).length());
input.setOptions(options);
DataTransferListener listener = getDataTransferListener();
input.setDataTransferListener(listener);
RateLimiter limiter = new DefaultRateLimiter(20 * 1024 * 1024, 5 * 1024 * 1024);
input.setRateLimiter(limiter);
UploadFileV2Output output = tos.uploadFile(input);
System.out.println("uploadFile succeed, object's etag is " + output.getEtag());
System.out.println("uploadFile succeed, object's crc64 is " + output.getHashCrc64ecma());
} catch (TosClientException e) {
System.out.println("uploadFile failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("uploadFile 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("uploadFile failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
private static DataTransferListener getDataTransferListener() {
return new DataTransferListener() {
@Override
public void dataTransferStatusChange(DataTransferStatus dataTransferStatus) {
if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_STARTED) {
System.out.println("uploadFile started.");
} else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_RW) {
System.out.printf("uploadFile, send %d bytes once, has sent %d bytes, total %d bytes.\n",
dataTransferStatus.getRwOnceBytes(), dataTransferStatus.getConsumedBytes(),
dataTransferStatus.getTotalBytes());
} else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_FAILED) {
System.out.printf("uploadFile failed, has sent %d bytes, total %d bytes.\n",
dataTransferStatus.getConsumedBytes(), dataTransferStatus.getTotalBytes());
} else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_SUCCEED) {
System.out.printf("uploadFile succeed, has sent %d bytes, total %d bytes.\n",
dataTransferStatus.getConsumedBytes(), dataTransferStatus.getTotalBytes());
}
}
};
}
}
Last updated: 2025.09.22 11:34:16
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
