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 InterfaceList objectsListing Objects with Multiple Versions (Node.js SDK)
Copy page
Download PDFList objects
Listing Objects with Multiple Versions (Node.js SDK)
Copy pageDownload PDFListing Objects with Multiple Versions (Node.js SDK)
This interface is used to enumerate multiversion objects in a bucket. Each request returns a portion of the bucket's multiversion objects (up to 1000 in a single request), and a subset of the objects in the bucket can be returned using request parameters as selection criteria.
Precautions
Before enumerating multiversion objects, you need to have the tos: ListBucketpermission, see Overview.
Parameter description
parameter | describe |
parameter | describe |
prefix | The prefix of this query result. |
delimiter | Characters to group object names. |
maxKeys | Returns the maximum number of enumerated objects, the default is 1000. Value: (0, 1000] |
encodingType | Encodes the returned content and specifies the type of encoding. The value selection description is as follows:
|
keyMarker | List the starting position of a multiversion object. Sets to return a list of objects sorted alphabetically from the value. Usually the NextKeyMarkervalue returned for the last request. |
versionIdMarker | Used in conjunction with keyMarker, sets a dictionary-sorted list of object pairs from this value. Gets from the NextVersionIDMarkerfrom the last enumeration. |
Sample code
Simple list
The following code enumerates up to 10 multiversion objects in a 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);
}
}
const bucketName = 'node-sdk-test-bucket';
async function main() {
try {
// Get up to 10 multi-version objects from the bucket.
const { data } = await client.listObjectVersions({
bucket: bucketName,
maxKeys: 1000,
});
printObjectVersions(data);
} catch (error) {
handleError(error);
}
}
function printObjectVersions(data) {
console.log('Versions.length:', data.Versions.length);
for (const obj of data.Versions) {
console.log('Obj Key:', obj.Key);
console.log('Obj Version ID:', obj.VersionID);
console.log('Obj Last Modified:', obj.LastModified);
console.log('Obj Is Latest Version:', obj.IsLatest);
}
console.log('DeleteMarkers.length:', data.DeleteMarkers.length);
for (const deleteMarker of data.DeleteMarkers) {
console.log('Delete Maker Key:', deleteMarker.Key);
console.log('Delete Maker Version ID:', deleteMarker.VersionID);
console.log('Delete Maker Last Modified:', deleteMarker.LastModified);
console.log('Delete Maker Is Latest Version:', deleteMarker.IsLatest);
}
}
main();
List all objects with the specified prefix
The following code enumerates all multiversion objects and deletion tags under the specified prefix for 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);
}
}
const bucketName = 'node-sdk-test-bucket';
async function main() {
try {
// List all multi-versioned objects with the specified prefix.
const prefix = '*** Provide your object key prefix ***';
for (let truncated = true, keyMarker = '', versionIdMarker = ''; truncated; ) {
const { data } = await client.listObjectVersions({
bucket: bucketName,
maxKeys: 1000,
prefix,
keyMarker,
versionIdMarker,
});
printObjectVersions(data);
truncated = data.IsTruncated;
keyMarker = data.NextKeyMarker;
versionIdMarker = data.NextVersionIdMarker;
}
} catch (error) {
handleError(error);
}
}
function printObjectVersions(data) {
console.log('Versions.length:', data.Versions.length);
for (const obj of data.Versions) {
console.log('Obj Key:', obj.Key);
console.log('Obj Version ID:', obj.VersionID);
console.log('Obj Last Modified:', obj.LastModified);
console.log('Obj Is Latest Version:', obj.IsLatest);
}
console.log('DeleteMarkers.length:', data.DeleteMarkers.length);
for (const deleteMarker of data.DeleteMarkers) {
console.log('Delete Maker Key:', deleteMarker.Key);
console.log('Delete Maker Version ID:', deleteMarker.VersionID);
console.log('Delete Maker Last Modified:', deleteMarker.LastModified);
console.log('Delete Maker Is Latest Version:', deleteMarker.IsLatest);
}
}
main();
List all objects
The following code enumerates all multiversion objects and deletion tags in the specification 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);
}
}
const bucketName = 'node-sdk-test-bucket';
async function main() {
try {
// List all multi-version objects.
for (let truncated = true, keyMarker = '', versionIdMarker = ''; truncated; ) {
const { data } = await client.listObjectVersions({
bucket: bucketName,
maxKeys: 1000,
keyMarker,
versionIdMarker,
});
printObjectVersions(data);
truncated = data.IsTruncated;
keyMarker = data.NextKeyMarker;
versionIdMarker = data.NextVersionIdMarker;
}
} catch (error) {
handleError(error);
}
}
function printObjectVersions(data) {
console.log('Versions.length:', data.Versions.length);
for (const obj of data.Versions) {
console.log('Obj Key:', obj.Key);
console.log('Obj Version ID:', obj.VersionID);
console.log('Obj Last Modified:', obj.LastModified);
console.log('Obj Is Latest Version:', obj.IsLatest);
}
console.log('DeleteMarkers.length:', data.DeleteMarkers.length);
for (const deleteMarker of data.DeleteMarkers) {
console.log('Delete Maker Key:', deleteMarker.Key);
console.log('Delete Maker Version ID:', deleteMarker.VersionID);
console.log('Delete Maker Last Modified:', deleteMarker.LastModified);
console.log('Delete Maker Is Latest Version:', deleteMarker.IsLatest);
}
}
main();
Recursive list objects and subdirectories in a directory
TOS only has the concept of objects, and can simulate the functionality of directories by creating an object of size 0 and ending with a slash/.
By delimiterand prefixtwo parameters can simulate the function of the directory:
- First set delimiterto/and set prefixto empty to return the object and subdirectory information in the root directory.
- Set delimiterto/and set prefixas subfiledir to return the objects and subdirectories of the subdirectory.
The following code is used to recursively list the objects and subdirectories in the directory. For all versions of the object information, the directory information only returns the latest version.
// 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);
}
}
const bucketName = 'node-sdk-test-bucket';
async function main() {
try {
// List all multi-version objects.
for (let truncated = true, keyMarker = '', versionIdMarker = ''; truncated; ) {
const { data } = await client.listObjectVersions({
bucket: bucketName,
maxKeys: 1000,
keyMarker,
versionIdMarker,
delimiter: '/',
});
// Print multiple version objects under the root directory.
console.log('Sub Dir Length:', data.CommonPrefixes.length);
for (const prefix of data.CommonPrefixes) {
console.log('Sub Dir:', prefix.Prefix);
}
// Print multiple version objects under the root directory.
printObjectVersions(data);
truncated = data.IsTruncated;
keyMarker = data.NextKeyMarker;
versionIdMarker = data.NextVersionIdMarker;
}
} catch (error) {
handleError(error);
}
}
function printObjectVersions(data) {
console.log('Versions.length:', data.Versions.length);
for (const obj of data.Versions) {
console.log('Obj Key:', obj.Key);
console.log('Obj Version ID:', obj.VersionID);
console.log('Obj Last Modified:', obj.LastModified);
console.log('Obj Is Latest Version:', obj.IsLatest);
}
console.log('DeleteMarkers.length:', data.DeleteMarkers.length);
for (const deleteMarker of data.DeleteMarkers) {
console.log('Delete Maker Key:', deleteMarker.Key);
console.log('Delete Maker Version ID:', deleteMarker.VersionID);
console.log('Delete Maker Last Modified:', deleteMarker.LastModified);
console.log('Delete Maker Is Latest Version:', deleteMarker.IsLatest);
}
}
main();
Related documentation
Last updated: 2025.09.22 18:35:48
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
