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 ReferenceNode.jsObject InterfaceUpload objectResumable Upload (Node.js SDK)
Copy page
Download PDFUpload object
Resumable Upload (Node.js SDK)
Copy pageDownload PDFResumable Upload (Node.js SDK)
When uploading an object to TOS using resumable upload, you can configure parameters such as part size, concurrency for uploading parts, client-side rate limiting, and event callback functions. If a network error or program crash occurs during the upload process, the upload will resume from the last recorded checkpoint and continue with the remaining parts. You can also cancel the upload by calling the Cancel method on the cancelToken passed to the upload operation.
Precautions
- Before uploading an object, you must have the tos: PutObject permission. For details, see Access control.
- When uploading an object, the object name must meet certain specifications. For details, see Common concepts.
- TOS is a distributed object storage product designed for mass storage. The internal partition stores object index data. In order to scale out the maximum throughput when uploading and downloading objects, and reduce the probability of hot partitions, please avoid using lexicographically increasing object naming.
- If an object with the same name already exists in the bucket, the new object will overwrite the existing object. If versioning is enabled in your bucket, the original object is preserved and a new version number is generated to identify the newly uploaded object.
- The SDK will record the uploaded status information in the Checkpoint file, so the program needs to have write permission to the Checkpoint file.
- When using resumable upload, upload progress information is recorded in a Checkpoint file. If a part fails to upload during the process, the upload resumes from the point recorded in the Checkpoint file on the next attempt. After the upload is complete, the Checkpoint file is deleted.
- If local files change during the upload process, all parts are re-uploaded.
Sample code
Upload an object
The following code uploads an object using resumable upload.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
const objectName = 'example_dir/multipartExample';
// The multipartExample file in the local example_dir folder.
const filePath = './example_dir/multipartExample';
const { data } = await client.uploadFile({
bucket: bucketName,
key: objectName,
// Uploaded file path
file: filePath,
// Specify the part size during upload
partSize: 5 * 1024 * 1024,
// Number of concurrent part upload tasks
taskNum: 5,
});
console.log('uploadFile result', data);
} catch (error) {
handleError(error);
}
}
main();
Traverse a local folder and upload its contents to a bucket
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
import fsp from 'fs/promises';
import path from 'path';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
// Directory where the uploaded object is located
const objectDirName = 'example_dir/';
// Upload all files under the local example_dir folder
const localDirPath = './example_dir/';
const localDirAbsolutePath = path.resolve(localDirPath) + '/';
async function walkDir(dirPath) {
for (const dirent of await fsp.readdir(dirPath, { withFileTypes: true })) {
const filePath = path.resolve(dirPath, dirent.name);
if (dirent.isDirectory()) {
walkDir(filePath);
continue;
}
const { data } = await client.uploadFile({
bucket: bucketName,
key: objectDirName + filePath.slice(localDirAbsolutePath.length),
// File path for upload
file: filePath,
// Specify part size for upload
partSize: 5 * 1024 * 1024,
// Number of concurrent part upload tasks
taskNum: 5,
});
console.log(`uploadFile ${filePath} result: `, data);
}
}
await walkDir(localDirPath);
} catch (error) {
handleError(error);
}
}
main();
Configure progress bar
During resumable upload, the progress can be received through the dataTransferStatusChangeparameter. The code example is as follows.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { DataTransferType, TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
const objectName = 'example_dir/multipartExample';
// The multipartExample file in the local example_dir folder.
const filePath = './example_dir/multipartExample';
const { data } = await client.uploadFile({
bucket: bucketName,
key: objectName,
// Uploaded file path
file: filePath,
// Specify the part size during upload
partSize: 5 * 1024 * 1024,
// Concurrent number of part upload tasks
taskNum: 5,
// Set up a callback function to monitor the upload progress through custom configuration.
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');
}
},
});
console.log('uploadFile result', data);
} catch (error) {
handleError(error);
}
}
main();
Configure event callbacks
The following code is used to customize the resumable upload callback function.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { UploadEventType, TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
const objectName = 'example_dir/multipartExample';
// The multipartExample file under the local example_dir folder.
const filePath = './example_dir/multipartExample';
const { data } = await client.uploadFile({
bucket: bucketName,
key: objectName,
// File path for upload
file: filePath,
// Specify the part size during upload
partSize: 5 * 1024 * 1024,
// Number of concurrent part upload tasks
taskNum: 5,
// Event listener callback
uploadEventChange: (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;
}
}
},
});
console.log('uploadFile result', data);
} catch (error) {
handleError(error);
}
}
main();
Configure client-side rate limiting
During resumable upload, you can use the tos.RateLimiter interface on the client side to limit the bandwidth usage. The code is as follows:
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { createDefaultRateLimiter, DataTransferType, TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
const objectName = 'example_dir/multipartExample';
// The multipartExample file under the local example_dir folder.
const filePath = './example_dir/multipartExample';
const rateLimit1M = 1024;
const { data } = await client.uploadFile({
bucket: bucketName,
key: objectName,
// File path for upload
file: filePath,
// Specify part size for upload
partSize: 5 * 1024 * 1024,
// Number of concurrent part upload tasks
taskNum: 5,
// Upload object and limit upload speed to 1M/s on the client side
rateLimiter: createDefaultRateLimiter(rateLimit1M, rateLimit1M),
// Set callback function to view upload progress in a custom way
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');
}
},
});
console.log('uploadFile result', data);
} catch (error) {
handleError(error);
}
}
main();
Cancellation mechanism
The following code is used to cancel an ongoing resumable upload task.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { CancelToken, TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(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 = 'node-sdk-test-bucket';
const objectName = 'example_dir/multipartExample';
// The multipartExample file under the local example_dir folder
const filePath = './example_dir/multipartExample';
// Generate cancelTokenSource
const cancelTokenSource = CancelToken.source();
client.uploadFile({
bucket: bucketName,
key: objectName,
// Uploaded file path
file: filePath,
// Specify the part size during upload
partSize: 5 * 1024 * 1024,
// Inject cancelToken
cancelToken: cancelTokenSource.token,
});
// Cancel task after 1 second.
setTimeout(() => {
cancelTokenSource.cancel();
console.log('cancel request');
}, 1000);
} catch (error) {
handleError(error);
}
}
main();
Last updated: 2026.08.12 17:40:43
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
