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 ReferenceHarmonyObject InterfaceUpload ObjectResumable Transfer (Harmony SDK)
Copy page
Download PDFUpload Object
Resumable Transfer (Harmony SDK)
Copy pageDownload PDFResumable Transfer (Harmony SDK)
When uploading files to TOS using the resumable upload method, you can configure parameters such as part size, concurrency for uploading parts, client-side rate limiting during upload, and event callback functions. During the upload process, if a network anomaly or program crash causes the file upload to fail, the system will resume uploading the incomplete portion from the last recorded breakpoint. During the upload process, you can cancel the object upload by invoking the Cancel method of the passed-in CancelHook.
Precautions
- Before uploading an object, you must have the tos:PutObject permission. For detailed instructions, refer to the Permission Configuration Guide.
- When uploading an object, the object name must comply with specific requirements. For detailed information, please refer to the Object Naming Specification.
- TOS is a distributed object storage product designed for large-scale storage, with internal partitions that store object index data. To maximize the throughput of uploading and downloading objects and reduce the likelihood of hotspot partitions, please avoid naming objects in lexicographical order. For more details, 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 permissions for the Checkpoint file.
- When using resumable upload, the file upload progress information is recorded in the Checkpoint file. If a chunk fails to upload during the process, retrying the upload will resume from the point recorded in the Checkpoint file. After the upload 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
Upload File
The following code is used to upload files using a resumable upload method.
/*
* Copyright (c) 2024 Beijing Volcano Engine Technology Ltd and/or its affiliates
* SPDX-License-Identifier: MIT
*/
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos_harmonyos_sdk';
const client = new TosClient({
accessKeyId: "Provide your ak",
accessKeySecret: "Provide your sk",
securityToken: 'Provide your securityToken',
region: "Provide your region",
endpoint: "Provide your endpoint",
});
function handleError(error: Error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.RequestID);
console.log('Response Status Code:', error.StatusCode);
console.log('Response Header:', error.Headers);
console.log('Response Err Code:', error.Code);
console.log('Response Err Msg:', error.Message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'harmony-sdk-test-bucket';
const objectName = 'example_dir/example.txt';
const filePath = './example_dir/multipartExample';
const checkpointFile = './example_dir/example.checkpoint';
await client.uploadFile({
Bucket: bucketName,
Key: objectName,
FilePath: filePath,
TaskNum: 1,
PartSize: 10 * 1024 * 1024,
CheckpointFile: checkpointFile,
EnableCheckpoint: true,
});
} catch (error) {
handleError(error);
}
}
main();
Configure Progress Bar
During resumable upload, upload progress can be received via the DataTransferStatusChange parameter. A code example is provided below.
import { DataTransferType, TosClient, TosClientError, TosServerError } from '@volcengine/tos_harmonyos_sdk';
const client = new TosClient({
accessKeyId: "Provide your ak",
accessKeySecret: "Provide your sk",
securityToken: 'Provide your securityToken',
region: "Provide your region",
endpoint: "Provide your endpoint",
});
function handleError(error: Error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.RequestID);
console.log('Response Status Code:', error.StatusCode);
console.log('Response Header:', error.Headers);
console.log('Response Err Code:', error.Code);
console.log('Response Err Msg:', error.Message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'harmony-sdk-test-bucket';
const objectName = 'example_dir/example.txt';
const filePath = './example_dir/multipartExample';
const checkpointFile = './example_dir/example.checkpoint';
await client.uploadFile({
Bucket: bucketName,
Key: objectName,
FilePath: filePath,
CheckpointFile: checkpointFile,
EnableCheckpoint: true,
DataTransferListener:{
DataTransferStatusChange(event){
if (event.Type === DataTransferType.Started) {
console.log('Data Transfer Started');
} else if (event.Type === DataTransferType.RW) {
const percent = ((event.ConsumedBytes / event.TotalBytes) * 100).toFixed(2);
console.log(`Once Read:${event.RWOnceBytes},ConsumerBytes/TotalBytes: ${event.ConsumedBytes}/${event.TotalBytes},${percent}%`);
} else if (event.Type === DataTransferType.Succeed) {
const percent = ((event.ConsumedBytes / event.TotalBytes) * 100).toFixed(2);
console.log(`Data Transfer Succeed, ConsumerBytes/TotalBytes:${event.ConsumedBytes}/${event.TotalBytes},${percent}%`);
} else if (event.Type === DataTransferType.Failed) {
console.log('Data Transfer Failed');
}
}
}
});
} catch (error) {
handleError(error);
}
}
main();
Handling Event Callbacks
The following code is used to customize the callback function for resumable upload.
import { TosClient, TosClientError, TosServerError, UploadEventType } from '@volcengine/tos_harmonyos_sdk';
const client = new TosClient({
accessKeyId: "Provide your ak",
accessKeySecret: "Provide your sk",
securityToken: 'Provide your securityToken',
region: "Provide your region",
endpoint: "Provide your endpoint",
});
function handleError(error: Error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.RequestID);
console.log('Response Status Code:', error.StatusCode);
console.log('Response Header:', error.Headers);
console.log('Response Err Code:', error.Code);
console.log('Response Err Msg:', error.Message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'harmony-sdk-test-bucket';
const objectName = 'example_dir/example.txt';
const filePath = './example_dir/multipartExample';
const checkpointFile = './example_dir/example.checkpoint';
await client.uploadFile({
Bucket: bucketName,
Key: objectName,
FilePath: filePath,
CheckpointFile: checkpointFile,
EnableCheckpoint: true,
UploadEventListener:{
EventChange(event){
switch (event.Type) {
case UploadEventType.CreateMultipartUploadSucceed: {
console.log(`Upload to ${event.Bucket} ${event.Key} create multipart upload success, upload id:${event.UploadID}`);
break;
}
case UploadEventType.CreateMultipartUploadFailed: {
console.log(`Upload to ${event.Bucket} ${event.Key} create multipart upload fail, upload id:${event.UploadID}`);
break;
}
case UploadEventType.UploadPartSucceed: {
console.log(`Upload to${event.Bucket} ${event.Key} part success, UploadPartInfo:%o`, event.UploadPartInfo);
break;
}
case UploadEventType.UploadPartAborted: {
console.log(`Upload to ${event.Bucket} ${event.Key} part aborted, upload id:${event.UploadID}`);
break;
}
case UploadEventType.UploadPartFailed: {
console.log(`Upload to ${event.Bucket} ${event.Key} part fail, upload id:${event.UploadID}`);
break;
}
case UploadEventType.CompleteMultipartUploadSucceed: {
console.log(`Upload to ${event.Bucket} ${event.Key} success, upload id:${event.UploadID}`);
break;
}
case UploadEventType.CompleteMultipartUploadFailed: {
console.log(`Upload to ${event.Bucket} ${event.Key} fail, upload id:${event.UploadID}, err: %o`, event.Err);
break;
}
}
}
}
});
} catch (error) {
handleError(error);
}
}
main();
Cancellation Mechanism
The following code is used to cancel an ongoing resumable upload task during runtime.
import { TosClient, TosClientError, TosServerError, UploadEventType, CancelHook } from '@volcengine/tos_harmonyos_sdk';
const client = new TosClient({
accessKeyId: "Provide your ak",
accessKeySecret: "Provide your sk",
securityToken: 'Provide your securityToken',
region: "Provide your region",
endpoint: "Provide your endpoint",
});
function handleError(error: Error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.RequestID);
console.log('Response Status Code:', error.StatusCode);
console.log('Response Header:', error.Headers);
console.log('Response Err Code:', error.Code);
console.log('Response Err Msg:', error.Message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
const cancelHook = new CancelHook();
try {
const bucketName = 'harmony-sdk-test-bucket';
const objectName = 'example_dir/example.txt';
const filePath = './example_dir/multipartExample';
const checkpointFile = './example_dir/example.checkpoint'
client.uploadFile({
Bucket: bucketName,
Key: objectName,
FilePath: filePath,
CancelHook: cancelHook,
CheckpointFile: checkpointFile,
EnableCheckpoint: true,
});
setTimeout(() => {
cancelHook.Cancel();
}, 1000)
} catch (error) {
handleError(error);
}
}
main();
Last updated: 2025.09.26 19:05:17
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
