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 objectMultipart Upload (Node.js SDK)
Copy page
Download PDFUpload object
Multipart Upload (Node.js SDK)
Copy pageDownload PDFMultipart Upload (Node.js SDK)
When uploading a large object, it can be divided into multiple data blocks (parts) to upload separately, and finally call merge sharding to merge the uploaded data blocks into one object.
Precautions
- Before uploading a shard, you must have tos: PutObjectpermission. For details,see Overview.
- Before canceling the shard upload task, you must have tos: AbortMultipartUploadpermission, see Overview.
- Sharding numbers start from 1 and go up to 10000. Except for the last sharding, all other shardings have a minimum size of 4MiB.
- 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.
Shard upload steps
Shard uploading generally involves the following three steps:
- Initialize the shard upload task: Call the createMultipartUpload method to return the globally unique UploadID created by TOS.
- Upload sharding
- Call the uploadPart method to upload the sharding data.
tip
- For the same shard upload task (identified by the UploadID), the sharding number (PartNumber) identifies the relative position of the sharding in the entire object. If you upload data multiple times through the same sharding number, the original data source will be overwritten in TOS, and the last uploaded data shall prevail.
- The response header contains the MD5 value of the data, which can be obtained by Etag. When merging shardings, you need to specify all the sharding information (sharding number, ETag value) in the current shard upload task.
- Finish sharding upload: When all sharding uploads are complete, call completeMultipartUpload method to merge all shardings into one complete object.
Sample code
Shard upload complete process
The following code shows the complete process of uploading local files by sharding, specifying ACL as Private, storage type as low-frequency storage, and adding custom metadata when uploading.
// 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 { ACLType, StorageClassType, TosClient, TosClientError, TosServerError } from '@volcengine/tos-sdk';
import fs from 'fs';
import fsp from 'fs/promises';
// 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';
// Initialize the shard, specify object permissions as private, storage class as infrequent access, and set metadata information.
const {
// Get upload task ID
data: { UploadId },
} = await client.createMultipartUpload({
bucket: bucketName,
key: objectName,
acl: ACLType.ACLPrivate,
storageClass: StorageClassType.StorageClassIa,
meta: { key: 'value ' },
});
console.log('CreateMultipartUploadV2 Upload ID:', UploadId);
// Get local file information and prepare for fragmentation
const stats = await fsp.stat(filePath);
// Total file size
const totalSize = stats.size;
// Set part size to 5M
const partSize = 5 * 1024 * 1024;
let offset = 0;
// partNumber starts from 1
let partNumber = 1;
const partsInfo = [];
while (offset < totalSize) {
const uploadResult = await client.uploadPart({
bucket: bucketName,
key: objectName,
partNumber,
uploadId: UploadId,
body: fs.createReadStream(filePath, {
start: offset,
end: offset + partSize - 1,
}),
});
const eTag = uploadResult.data.ETag;
console.log(`partNumber${partNumber} Etag:`, eTag);
partsInfo.push({
partNumber,
eTag,
});
partNumber++;
offset += partSize;
}
console.log('parts information', partsInfo);
// Complete chunked upload
const { data } = await client.completeMultipartUpload({
bucket: bucketName,
key: objectName,
uploadId: UploadId,
parts: partsInfo,
});
console.log('result data:', data);
} catch (error) {
handleError(error);
}
}
main();
List uploaded shardings
The following code enumerates the uploaded sharding information for the specified object in the specified 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';
// 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 = '*** Provide your object name ***';
// Multipart upload task ID can be obtained from the createMultipartUpload interface.
const uploadId = '*** Provide upload ID ***';
// List the uploaded shard information for uploadID.
for (let truncated = true, marker = 0; truncated; ) {
const { data } = await client.listParts({
bucket: bucketName,
key: objectName,
uploadId,
partNumberMarker: marker,
});
truncated = data.IsTruncated;
marker = data.NextPartNumberMarker;
for (const part of data.Parts) {
console.log(`Part Number: `, part.PartNumber);
console.log(`ETag: `, part.ETag);
console.log(`Size: `, part.Size);
}
}
} catch (error) {
handleError(error);
}
}
main();
Cancel shard upload task
You can cancel the shard upload task through abortMultipartUpload methods. When a sharding task is cancelled, TOS will delete the uploaded sharding data, and you can no longer perform any operations on the sharding 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 { 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.
});
async function main() {
try {
const bucketName = 'node-sdk-test-bucket';
const objectName = '*** Provide your object name ***';
// Multipart upload task ID, which can be obtained from the createMultipartUpload interface.
const uploadId = `*** Provide upload ID ***`;
// Cancel chunked upload task.
const { data } = await client.abortMultipartUpload({
bucket: bucketName,
key: objectName,
uploadId,
});
console.log('result data:', data);
} catch (error) {
handleError(error);
}
}
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);
}
}
main();
Related documentation
- For API documentation on creating a shard upload task, see CreateMultipartUpload.
- For API documentation on uploading sharding, see UploadPart.
- For API documentation on merge sharding, see CompleteMultipartUpload.
- For API documentation on canceling shard upload tasks, see AbortMultipartUpload.
Last updated: 2025.09.22 18:35:47
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
