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 ReferencePythonObject interfaceList objectsList objects V2 (Python SDK)
Copy page
Download PDFList objects
List objects V2 (Python SDK)
Copy pageDownload PDFList objects V2 (Python SDK)
This article explains how to list all objects in a specified bucket, files with a specified prefix, files and subdirectories under a specified directory using ListObjectsType2.
Notes
- The ListObjects interface has been revised to ListObjectsType2. Developers are strongly recommended to use ListObjectsType2. To ensure backward compatibility, TOS continues to support the ListObjects interface.
- To use list objects V2, you must have tos:ListBucket permission. For details, see IAM policy overview.
Parameter description
ListObjectsType2 supports the following parameters.
Parameter | Description |
Parameter | Description |
prefix | Prefix for this query result. |
delimiter | The character used to group object names. |
start_after | The starting point of this listing target. |
continuation_token | Specify the token from which the listing operation starts. Can be obtained from the next_continuation_token in the previous listing result. |
max_keys | The maximum number of listing targets returned, default is 1000. Value range: greater than 0 and less than or equal to 1000. |
Example code
Simple listing
The following code lists up to 10 objects in the bucket-test bucket.
import os
import tos
# Retrieve AKSK information from environment variables.
ak = os.getenv('TOS_ACCESS_KEY')
sk = os.getenv('TOS_SECRET_KEY')
endpoint = "your endpoint"
region = "your region"
bucket_name = "bucket-test"
try:
# Create a TosClientV2 object to perform operations on buckets and objects
client = tos.TosClientV2(ak, sk, endpoint, region)
# The code example for listing 10 objects in a bucket is as follows:
result = client.list_objects_type2(bucket_name, max_keys=10)
for item in result.contents:
print(item.key)
except tos.exceptions.TosClientError as e:
# Operation failed, catch client error, usually caused by invalid request parameters or network issues
print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))
except tos.exceptions.TosServerError as e:
# Operation failed, catch server error, detailed error information can be obtained from the response
print('fail with server error, code: {}'.format(e.code))
# request id can be used to locate specific issues, it is strongly recommended to save it in the log.
print('error with request id: {}'.format(e.request_id))
print('error with message: {}'.format(e.message))
print('error with http code: {}'.format(e.status_code))
print('error with ec: {}'.format(e.ec))
print('error with request url: {}'.format(e.request_url))
except Exception as e:
print('fail with unknown error: {}'.format(e))
List with pagination
The following code lists objects in the bucket-test bucket with pagination.
import os
import tos
# Retrieve AKSK information from environment variables.
ak = os.getenv('TOS_ACCESS_KEY')
sk = os.getenv('TOS_SECRET_KEY')
# Fill in "your endpoint" and "your region" with the corresponding Endpoint of the region where your Bucket is located. Taking the example of North China 2 (Beijing), fill in "your endpoint" with tos-cn-beijing.volces.com and "your region" with cn-beijing.
endpoint = "your endpoint"
region = "your region"
bucket_name = "bucket-test"
try:
client = tos.TosClientV2(ak, sk, endpoint, region)
# List the first 1000 objects in the pagination bucket.
result = client.list_objects_type2(bucket_name)
for item in result.contents:
print(item.key)
# If the pagination has not listed all subsequent 1000 objects.
if result.is_truncated:
result = client.list_objects_type2(bucket_name, continuation_token=result.next_continuation_token)
for item in result.contents:
print(item.key)
except tos.exceptions.TosClientError as e:
# Operation failed, catch client error, usually caused by invalid request parameters or network issues
print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))
except tos.exceptions.TosServerError as e:
# Operation failed, catch server error, detailed error information can be obtained from the response
print('fail with server error, code: {}'.format(e.code))
# request id can be used to locate specific issues, it is strongly recommended to save it in the log.
print('error with request id: {}'.format(e.request_id))
print('error with message: {}'.format(e.message))
print('error with http code: {}'.format(e.status_code))
print('error with ec: {}'.format(e.ec))
print('error with request url: {}'.format(e.request_url))
except Exception as e:
print('fail with unknown error: {}'.format(e))
List all objects with a specific prefix
The following code lists all objects with a specific prefix in the bucket-test bucket.
import os
import tos
# Retrieve AKSK information from environment variables.
ak = os.getenv('TOS_ACCESS_KEY')
sk = os.getenv('TOS_SECRET_KEY')
# Fill in "your endpoint" and "your region" with the corresponding Endpoint of the region where your Bucket is located. Taking the example of North China 2 (Beijing), fill in "your endpoint" with tos-cn-beijing.volces.com and "your region" with cn-beijing.
endpoint = "your endpoint"
region = "your region"
bucket_name = "bucket-test"
prefix = "your prefix"
try:
# Create a TosClientV2 object to perform operations on buckets and objects
client = tos.TosClientV2(ak, sk, endpoint, region)
# List all objects with a specific prefix under a specified bucket.
truncated = True
continuation_token = ''
while truncated:
result = client.list_objects_type2(bucket_name, prefix=prefix, continuation_token=continuation_token)
for item in result.contents:
print(item.key)
truncated = result.is_truncated
continuation_token = result.next_continuation_token
except tos.exceptions.TosClientError as e:
# Operation failed, catch client error, usually caused by invalid request parameters or network issues
print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))
except tos.exceptions.TosServerError as e:
# Operation failed, catch server error, detailed error information can be obtained from the response
print('fail with server error, code: {}'.format(e.code))
# request id can be used to locate specific issues, it is strongly recommended to save it in the log.
print('error with request id: {}'.format(e.request_id))
print('error with message: {}'.format(e.message))
print('error with http code: {}'.format(e.status_code))
print('error with ec: {}'.format(e.ec))
print('error with request url: {}'.format(e.request_url))
except Exception as e:
print('fail with unknown error: {}'.format(e))
List all objects in the bucket
The following code lists all objects in the bucket-test bucket.
import os
import tos
# Retrieve AKSK information from environment variables.
ak = os.getenv('TOS_ACCESS_KEY')
sk = os.getenv('TOS_SECRET_KEY')
# Fill in "your endpoint" and "your region" with the corresponding Endpoint of the region where your Bucket is located. Taking the example of North China 2 (Beijing), fill in "your endpoint" with tos-cn-beijing.volces.com and "your region" with cn-beijing.
endpoint = "your endpoint"
region = "your region"
bucket_name = "bucket-test"
try:
# Create a TosClientV2 object to perform operations on buckets and objects
client = tos.TosClientV2(ak, sk, endpoint, region)
# List all objects under a specified bucket.
truncated = True
continuation_token = ''
while truncated:
result = client.list_objects_type2(bucket_name, continuation_token=continuation_token)
for item in result.contents:
print(item.key)
truncated = result.is_truncated
continuation_token = result.next_continuation_token
except tos.exceptions.TosClientError as e:
# Operation failed, catch client error, usually caused by invalid request parameters or network issues
print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))
except tos.exceptions.TosServerError as e:
# Operation failed, catch server error, detailed error information can be obtained from the response
print('fail with server error, code: {}'.format(e.code))
# request id can be used to locate specific issues, it is strongly recommended to save it in the log.
print('error with request id: {}'.format(e.request_id))
print('error with message: {}'.format(e.message))
print('error with http code: {}'.format(e.status_code))
print('error with ec: {}'.format(e.ec))
print('error with request url: {}'.format(e.request_url))
except Exception as e:
print('fail with unknown error: {}'.format(e))
List files and subdirectories under a specific directory
TOS only has the concept of objects, and you can simulate directory functionality by creating an object ending with a slash and has a size of 0./Ending with a slash to simulate directory functionality.
You can simulate directory functions using two parameters: delimiter and prefix.
- First, set delimiter to/Set prefix to empty to return objects and subdirectory information under the root directory.
- Set delimiter to/Set prefix to the subdirectory to return objects and subdirectories within that subdirectory.
The following code lists files and subdirectories in a specified directory.
import os
import tos
# Retrieve AKSK information from environment variables.
ak = os.getenv('TOS_ACCESS_KEY')
sk = os.getenv('TOS_SECRET_KEY')
# Fill in "your endpoint" and "your region" with the corresponding Endpoint of the region where your Bucket is located. Taking the example of North China 2 (Beijing), fill in "your endpoint" with tos-cn-beijing.volces.com and "your region" with cn-beijing.
endpoint = "your endpoint"
region = "your region"
bucket_name = "bucket-test"
try:
# Create a TosClientV2 object to perform operations on buckets and objects
client = tos.TosClientV2(ak, sk, endpoint, region)
# Add subdirectories named fun1, fun2, and fun3, along with a file named test, to the Bucket.
client.put_object(bucket_name, "fun1/")
client.put_object(bucket_name, "fun1/test/")
client.put_object(bucket_name, "fun1/obj.txt")
client.put_object(bucket_name, "fun2/")
client.put_object(bucket_name, "fun3/")
client.put_object(bucket_name, "test")
# 1. List files and subdirectories in the root directory.
is_truncated = True
next_continuation_token = ''
while is_truncated:
out = client.list_objects_type2(bucket_name, delimiter="/", continuation_token=next_continuation_token)
is_truncated = out.is_truncated
next_continuation_token = out.next_continuation_token
# common_prefixes returns the subdirectories under the root directory.
for prefix in out.common_prefixes:
print('subDir', prefix.prefix)
# The contents return the objects in the root directory.
for content in out.contents:
print('file', content.key)
# 2. List files and subdirectories under the fun1/ directory.
is_truncated = True
next_continuation_token = ''
while is_truncated:
out = client.list_objects_type2(bucket_name, delimiter="/", prefix="fun1/", continuation_token=next_continuation_token)
is_truncated = out.is_truncated
next_continuation_token = out.next_continuation_token
# common_prefixes returns the subdirectories under the fun1/ directory.
for prefix in out.common_prefixes:
print('subDir', prefix.prefix)
# The contents returned the objects under the directory fun1.
for content in out.contents:
print('file', content.key)
except tos.exceptions.TosClientError as e:
# Operation failed, catch client error, usually caused by invalid request parameters or network issues
print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))
except tos.exceptions.TosServerError as e:
# Operation failed, catch server error, detailed error information can be obtained from the response
print('fail with server error, code: {}'.format(e.code))
# request id can be used to locate specific issues, it is strongly recommended to save it in the log.
print('error with request id: {}'.format(e.request_id))
print('error with message: {}'.format(e.message))
print('error with http code: {}'.format(e.status_code))
print('error with ec: {}'.format(e.ec))
print('error with request url: {}'.format(e.request_url))
except Exception as e:
print('fail with unknown error: {}'.format(e))
Last updated: 2025.09.17 18:22:11
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
