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 InterfaceList Objects v2Enumerate Objects V2 (Harmony SDK)
Copy page
Download PDFList Objects v2
Enumerate Objects V2 (Harmony SDK)
Copy pageDownload PDFEnumerate Objects V2 (Harmony SDK)
This article describes how to use listObjectsType2 to enumerate all objects within a specified bucket, files with a specified prefix, as well as files and subdirectories within a specified directory.
Precautions
- The ListObjects interface has been revised to ListObjectsType2. Developers are strongly encouraged to use ListObjectsType2. To ensure backward compatibility, TOS continues to support the ListObjects interface.
- To use List Objects V2, you must have the tos:ListBucket permission. For details, see IAM Policy Overview.
Parameter Description
The parameters supported by ListObjectsType2 are as follows:
Parameters | Description |
Parameters | Description |
Prefix | The prefix of the current query results. |
Delimiter | The character used to group object names. |
StartAfter | The starting point for the objects enumerated in this instance. |
ContinuationToken | The specified enumeration operation must begin from this token. It can be obtained from the NextContinuationToken in the results of the previous listing. |
MaxKeys | Returns the maximum number of objects to be listed; the default value is 1000. The permissible value range is (0, 1000]. |
EncodingType | Encode the returned content and specify the type of encoding. The possible values are as follows:
|
Sample Code
Brief Enumeration
The following code is used to enumerate objects in the bucket named 'bucketName', listing up to 1,000 objects.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-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) {
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 res = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
});
for (const obj of res.Contents) {
console.log('Object Key:', obj.Key);
console.log('Object LastModified:', obj.LastModified);
console.log('Object ETag:', obj.ETag);
console.log('Object Size:', obj.Size);
console.log('Object Owner:', obj.Owner);
console.log('Object StorageClass:', obj.StorageClass);
console.log('Object HashCrc64ecma:', obj.HashCrc64ecma);
}
} catch (error) {
handleError(error);
}
}
main();
Paginated Listing
The following code is used to paginate the listing of the first 1000 and last 1000 objects in the bucket named bucketName.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-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 res = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
});
const res2 = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
ContinuationToken: res.NextContinuationToken,
});
} catch (error) {
handleError(error);
}
}
main();
List all objects with the specified prefix
The following code enumerates objects with the prefix 'prefix' in the bucket 'bucketName'.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-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) {
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 prefix = '*** Provide your object key prefix ***';
let continuationToken = '';
while (true) {
const res = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
ContinuationToken: continuationToken,
Prefix: prefix,
});
if (!res.NextContinuationToken) {
break;
}
continuationToken = res.NextContinuationToken;
}
} catch (error) {
handleError(error);
}
}
main();
Paginated Listing of All Objects in a Bucket
The following code is used to paginate and list all objects in the 'bucketName' storage bucket.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-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) {
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 {
let continuationToken = '';
while (true) {
const res = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
ContinuationToken: continuationToken,
});
if (!res.NextContinuationToken) {
break;
}
continuationToken = res.NextContinuationToken;
}
} catch (error) {
handleError(error);
}
}
main();
List the files and subdirectories in the specified directory.
TOS supports only the concept of objects; it is possible to create an object with a size of zero and a slash in its name./The object at the end simulates the functionality of a directory.
The functionality of a directory can be simulated by using the two parameters delimiter and prefix:
- First, set the delimiter to/By also setting prefix to an empty value, you can retrieve information about objects and subdirectories in the root directory.
- When setting delimiter to/At the same time, set prefix as a subdirectory (subfiledir), so that objects and sub-level directories within that subdirectory can be returned.
The following code is used to enumerate objects and subdirectories in the root directory of the bucket named bucketName.
import { TosClient, TosClientError, TosServerError } from '@volcengine/tos-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) {
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 {
let continuationToken = '';
while (true) {
const res = await client.listObjectsType2({
Bucket: bucketName,
MaxKeys: 1000,
ContinuationToken: continuationToken,
Delimiter: '/',
});
console.log('Sub Dir Length:', res.CommonPrefixes.length);
for (const prefix of res.CommonPrefixes) {
console.log('Sub Dir:', prefix.Prefix);
}
if (!res.NextContinuationToken) {
break
}
continuationToken = res.NextContinuationToken;
}
} catch (error) {
handleError(error);
}
}
main();
Last updated: 2025.09.26 19:05:15
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
