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 ObjectMultipart Upload (Harmony SDK)
Copy page
Download PDFUpload Object
Multipart Upload (Harmony SDK)
Copy pageDownload PDFMultipart Upload (Harmony SDK)
When uploading large objects, the data can be divided into multiple parts for separate upload. Finally, the merge operation is invoked to combine the uploaded parts into a single object.
Precautions
- Before initiating multipart upload, you must have the tos:PutObject permission. For detailed instructions, please refer to the Permission Configuration Guide.
- Before canceling a multipart upload task, you must have the tos:AbortMultipartUpload permission. For details on how to perform this operation, please refer to the Permission Configuration Guide.
- Shard numbering starts at 1, with a maximum value of 10,000. Except for the last fragment, the minimum size of all other fragments is 4 MiB.
- 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 large-scale data storage. Its internal partitions store object index data. To horizontally scale the maximum throughput for uploading and downloading objects, and to reduce the probability of hotspot partitions, please avoid using lexicographically incremental object naming. 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.
Multipart Upload Procedure
Multipart upload typically consists of the following three steps:
- Initialize the multipart upload task: Call the createMultipartUpload method, which returns the globally unique UploadID created by TOS.
- Upload Part: Invoke the uploadPart method to upload part data.
tip
- For the same multipart upload task (identified by UploadID), the part number (PartNumber) specifies the relative position of the part within the entire object. If data is uploaded multiple times using the same shard number, TOS will overwrite the original data and retain only the most recently uploaded version.
- The response header contains the MD5 value of the data, which can be obtained via the Etag. When merging parts, you must specify all part information (part number and ETag value) from the current multipart upload task.
- Completing Multipart Upload: After all parts have been uploaded, invoke the completeMultipartUpload method to merge all parts into a single object.
Sample Code
Complete Process of Multipart Upload
The following code demonstrates the complete process of uploading a local file using multipart upload, specifying the ACL as Private, setting the storage type to low-frequency storage, and adding custom metadata during the upload.
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/multipartExample';
const filePath = './example_dir/multipartExample';
const res = await client.createMultipartUpload({
Bucket: bucketName,
Key: objectName,
ACL: ACLType.ACLPrivate,
StorageClass: StorageClassType.StorageClassIa,
});
console.log('CreateMultipartUploadV2 Upload ID:', res.UploadId);
const stats = await fs.statSync(filePath);
const totalSize = stats.size;
const partSize = 5 * 1024 * 1024;
let offset = 0;
let partNumber = 1;
const partsInfo: UploadedPart[] = [];
while (offset < totalSize) {
const uploadResult = await client.uploadPart({
Bucket: bucketName,
Key: objectName,
PartNumber: partNumber,
UploadID: res.UploadId,
Content: fs.createReadStream(filePath, {
start: offset,
end: offset + partSize - 1,
}),
});
const eTag = uploadResult.ETag;
console.log(`partNumber${partNumber} Etag:`, eTag);
partsInfo.push(new UploadedPart(partNumber, eTag));
partNumber++;
offset += partSize;
}
console.log('parts information', partsInfo);
const completeRes = await client.completeMultipartUpload({
Bucket: bucketName,
Key: objectName,
UploadID: res.UploadId,
Parts: partsInfo,
});
console.log('result status:', completeRes.StatusCode);
} catch (error) {
handleError(error);
}
}
main();
List Uploaded Chunks
The following code is used to enumerate information about the uploaded parts of a specified object within a designated storage bucket.
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 = 'node-sdk-test-bucket';
const objectName = '*** Provide your object name ***';
const uploadId = '*** Provide upload ID ***';
let marker = 0;
while (true) {
const res= await client.listParts({
Bucket: bucketName,
Key: objectName,
UploadId: uploadId,
PartNumberMarker: marker,
});
if (!res.IsTruncated || res.NextPartNumberMarker === undefined) {
break;
}
marker = res.NextPartNumberMarker;
for (const part of res.Parts) {
console.log(`Part Number: `, part.PartNumber);
console.log(`ETag: `, part.ETag);
console.log(`Size: `, part.Size);
}
}
} catch (error) {
handleError(error);
}
}
main();
Cancel Multipart Upload Task
You can cancel a multipart upload task using the abortMultipartUpload method. Once a multipart upload task is canceled, TOS will delete all previously uploaded part data. You will also be unable to perform any further operations on this multipart upload task.
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 = '*** Provide your object name ***';
const uploadId = `*** Provide upload ID ***`;
const res = await client.abortMultipartUpload({
Bucket: bucketName,
Key: objectName,
UploadID: uploadId,
});
console.log('result status:', res.StatusCode);
} catch (error) {
handleError(error);
}
}
main();
Relevant Documentation
- For the API documentation on creating a multipart upload task, please refer to CreateMultipartUpload.
- For API documentation on uploading parts, refer to UploadPart.
- For API documentation on merging multipart uploads, refer to CompleteMultipartUpload.
- For API documentation on aborting multipart upload tasks, refer to AbortMultipartUpload.
Last updated: 2025.09.26 19:05:14
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
