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 ReferenceC++Object InterfaceUpload ObjectResumable Transfer (C++ SDK)
Copy page
Download PDFUpload Object
Resumable Transfer (C++ SDK)
Copy pageDownload PDFResumable Transfer (C++ SDK)
Before uploading files to TOS using resumable upload, you can configure parameters such as part size, number of upload threads, client-side upload speed limit, and event callback functions. It is also possible to cancel the task during the execution of a resumable upload task. If a network error or similar issue causes the file upload to fail, the system will resume uploading the unfinished portion from the last recorded breakpoint.
Precautions
- Before uploading an object, you must have the tos:PutObject permission. For detailed instructions, please refer to the Permission Configuration Guide.
- When uploading objects, object names must comply with specific standards. For detailed information, please refer to Object Naming Guidelines.
- TOS is a distributed object storage product designed for massive storage, with internal partitions that store object index data. To maximize the throughput of your object uploads and downloads and to reduce the likelihood of hotspot partitions as the system scales horizontally, please avoid using object names that increase in lexicographical order. For more information, see Performance Optimization.
- If an object with the same name already exists in the bucket, the new object will overwrite the existing one. If versioning is enabled for your bucket, the original object will be retained, and a new version number will be generated to identify the newly uploaded object.
- The SDK records the upload status information in the Checkpoint file, so the program must have write permission for the Checkpoint file.
- When using resumable upload, the file upload progress information is recorded in the Checkpoint file. If a part fails to upload during the process, the next upload will resume from the point recorded in the Checkpoint file. Once uploading is complete, the Checkpoint file will be deleted.
- If the local file is modified during the upload process, all segments will be re-uploaded.
Sample Code
Resumable Upload
The following code is used for resumable upload, transferring a local file to the object exampledir/exampleobject.txt in the target bucket examplebucket. If a network timeout error is returned during the upload process, you can resume the upload from the breakpoint by invoking uploadFile again with the same parameters.
#include "TosClientV2.h"
using namespace VolcengineTos;
int main(void){
std::string region = "Your Region";
std::string accessKey = std::getenv("TOS_ACCESS_KEY");
std::string secretKey = std::getenv("TOS_SECRET_KEY");
std::string bucketName = "examplebucket";
std::string objectName = "exampledir/exampleobject.txt";
std::string filePath = "/localpath/examplefile.txt";
std::string CheckpointFilePath = "yourCheckpointFilepath";
InitializeClient();
TosClientV2 client(region, accessKey, secretKey);
UploadFileV2Input input(bucketName, objectName);
input.setTaskNum(10);
input.setEnableCheckpoint(true);
input.setPartSize(20 * 1024 * 1024);
input.setFilePath(filePath);
auto output = client.uploadFile(input);
if (!output.isSuccess()) {
std::cout << "UploadFile failed." << output.error().String() << std::endl;
CloseClient();
return -1;
}
std::cout << "UploadFile success. object etag is: " << output.result().getETag() << std::endl;
CloseClient();
return 0;
}
Processing Progress Bar
The following code is used to configure the upload progress bar functionality for resumable uploads.
#include "TosClientV2.h"
using namespace VolcengineTos;
static void ProgressCallback(std::shared_ptr<DataTransferStatus> datatransferstatus) {
int64_t consumedBytes = datatransferstatus->consumedBytes_;
int64_t totalBytes = datatransferstatus->totalBytes_;
int64_t rwOnceBytes = datatransferstatus->rwOnceBytes_;
DataTransferType type = datatransferstatus->type_;
int64_t rate = 100 * consumedBytes / totalBytes;
std::cout << "rate:" << rate << ","
<< "ConsumedBytes:" << consumedBytes << ","
<< "totalBytes:" << totalBytes << ","
<< "rwOnceBytes:" << rwOnceBytes << ","
<< "DataTransferType:" << type << std::endl;
}
int main(void){
std::string region = "Your Region";
std::string accessKey = std::getenv("TOS_ACCESS_KEY");
std::string secretKey = std::getenv("TOS_SECRET_KEY");
std::string bucketName = "examplebucket";
std::string objectName = "exampledir/exampleobject.txt";
std::string filePath = "/localpath/examplefile.txt";
std::string CheckpointFilePath = "yourCheckpointFilepath";
InitializeClient();
TosClientV2 client(region, accessKey, secretKey);
UploadFileV2Input input(bucketName, objectName);
input.setTaskNum(10);
input.setEnableCheckpoint(true);
input.setPartSize(20 * 1024 * 1024);
input.setFilePath(filePath);
DataTransferListener processHandler = {ProgressCallback, nullptr};
input.setDataTransferListener(processHandler);
auto output = client.uploadFile(input);
if (!output.isSuccess()) {
std::cout << "UploadFile failed." << output.error().String() << std::endl;
CloseClient();
return -1;
}
std::cout << "UploadFile success. object etag is: " << output.result().getETag() << std::endl;
CloseClient();
return 0;
}
Handling Event Callbacks
During the invocation of the uploadFile interface, events such as chunk initialization, chunk uploading, and chunk merging are triggered. You may pass in a custom interface to listen for relevant upload events and implement your own business logic. The following code demonstrates the functionality of a custom callback function for resumable upload.
#include "TosClientV2.h"
using namespace VolcengineTos;
static void UploadCallBack(std::shared_ptr<UploadEvent> event) {
UploadEventType type_ = event->type_;
bool error_ = event->error_;
std::string bucket_ = event->bucket_;
std::string key_ = event->key_;
std::string fileInfo = bucket_ + key_;
std::shared_ptr<std::string> uploadId_ = event->uploadId_;
std::shared_ptr<std::string> checkpointFile_ = event->checkpointFile_;
std::shared_ptr<UploadPartInfo> uploadPartInfo_ = event->uploadPartInfo_;
std::string uploadPartInfo = "";
if (uploadPartInfo_ != nullptr) {
uploadPartInfo = std::to_string(uploadPartInfo_->partSize_) + "," + std::to_string(uploadPartInfo_->offset_) +
"," + std::to_string(uploadPartInfo_->partNumber_) + "," + *(uploadPartInfo_->eTag_) + "," +
std::to_string(*(uploadPartInfo_->hashCrc64ecma_));
}
std::cout << "type:" << type_ << ","
<< "error:"<< error_ << ","
<< "fileInfo:" << fileInfo << ","
<< "checkpointFile:" << *checkpointFile_ << ","
<< "uploadId:" << *uploadId_ << ","
<< "uploadPartInf:" << uploadPartInfo << std::endl;
}
int main(void){
std::string region = "Your Region";
std::string accessKey = std::getenv("TOS_ACCESS_KEY");
std::string secretKey = std::getenv("TOS_SECRET_KEY");
std::string bucketName = "examplebucket";
std::string objectName = "exampledir/exampleobject.txt";
std::string filePath = "/localpath/examplefile.txt";
std::string CheckpointFilePath = "yourCheckpointFilepath";
InitializeClient();
TosClientV2 client(region, accessKey, secretKey);
UploadFileV2Input input(bucketName, objectName);
input.setTaskNum(10);
input.setEnableCheckpoint(true);
input.setPartSize(20 * 1024 * 1024);
input.setFilePath(filePath);
UploadEventListener uploadHandler = {UploadCallBack};
input.setUploadEventListener(uploadHandler);
auto output = client.uploadFile(input);
if (!output.isSuccess()) {
std::cout << "UploadFile failed." << output.error().String() << std::endl;
CloseClient();
return -1;
}
std::cout << "UploadFile success. object etag is: " << output.result().getETag() << std::endl;
CloseClient();
return 0;
}
Configuring Client Bandwidth Limitation
The following code is used to configure rate limiting for the resumable upload client.
#include "TosClientV2.h"
using namespace VolcengineTos;
int main(void){
std::string region = "Your Region";
std::string accessKey = std::getenv("TOS_ACCESS_KEY");
std::string secretKey = std::getenv("TOS_SECRET_KEY");
std::string bucketName = "examplebucket";
std::string objectName = "exampledir/exampleobject.txt";
std::string filePath = "/localpath/examplefile.txt";
std::string CheckpointFilePath = "yourCheckpointFilepath";
InitializeClient();
TosClientV2 client(region, accessKey, secretKey);
UploadFileV2Input input(bucketName, objectName);
input.setTaskNum(10);
input.setEnableCheckpoint(true);
input.setPartSize(20 * 1024 * 1024);
input.setFilePath(filePath);
std::shared_ptr<RateLimiter> RateLimiter(NewRateLimiter(20 * 1024 * 1024, 5 * 1024 * 1024));
input.setRateLimiter(RateLimiter);
auto output = client.uploadFile(input);
if (!output.isSuccess()) {
std::cout << "UploadFile failed." << output.error().String() << std::endl;
CloseClient();
return -1;
}
std::cout << "UploadFile success. object etag is: " << output.result().getETag() << std::endl;
CloseClient();
return 0;
}
Cancellation Mechanism
The uploadFile interface allows you to actively pause or cancel resumable upload tasks. Pausing a resumable upload task will halt the upload process. When uploadFile is called again, the upload can resume from the point where it was previously paused. Canceling a resumable upload task will halt the upload process, delete the local CheckPoint file, and invoke abortMultipartUpload to remove the multipart upload task. If uploadFile is called again, the upload will restart from the beginning.
The following code demonstrates how to pause or cancel a resumable transfer.
#include "TosClientV2.h"
#include <thread>
using namespace VolcengineTos;
static void threadFunction1(TosClientV2 client, UploadFileV2Input input) {
auto output = client.uploadFile(input);
if (!output.isSuccess()) {
std::cout << "UploadFile failed." << output.error().String() << std::endl;
}
std::cout << "UploadFile success. object etag is: " << output.result().getETag() << std::endl;
}
static void threadFunction2(std::shared_ptr<CancelHook> CancelHook) {
CancelHook->Cancel(false);
}
int main(void){
std::string region = "Your Region";
std::string accessKey = std::getenv("TOS_ACCESS_KEY");
std::string secretKey = std::getenv("TOS_SECRET_KEY");
std::string bucketName = "examplebucket";
std::string objectName = "exampledir/exampleobject.txt";
std::string filePath = "/localpath/examplefile.txt";
std::string CheckpointFilePath = "yourCheckpointFilepath";
InitializeClient();
TosClientV2 client(region, accessKey, secretKey);
UploadFileV2Input input(bucketName, objectName);
input.setTaskNum(10);
input.setEnableCheckpoint(true);
input.setPartSize(20 * 1024 * 1024);
input.setFilePath(filePath);
std::shared_ptr<CancelHook> CancelHook(NewCancelHook());
input.setCancelHook(CancelHook);
std::thread thread1(threadFunction1, client, input);
thread1.detach();
TimeUtils::sleepSecondTimes(5);
std::thread thread2(threadFunction2, CancelHook);
thread1.join();
thread2.join();
CloseClient();
return 0;
}
Last updated: 2025.09.25 14:22:47
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
