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.jsBucket InterfaceManage Bucket ConfigurationManaging Origin Fetch (Node.js SDK)
Copy page
Download PDFManage Bucket Configuration
Managing Origin Fetch (Node.js SDK)
Copy pageDownload PDFManaging Origin Fetch (Node.js SDK)
Mirroring back to the source is mainly used for scenarios where data is seamlessly migrated to TOS. For example, if the web service is already running on your own source site, and you migrate the static web page to the TOS storage, you can configure the mirror back to the source rule to obtain some data that has not been migrated to the TOS.
Set mirror return to source
warning
- A bucket only supports the creation of a back-to-source rule.
- Mirroring back to the source can support up to 5GiB of objects. If you need to request objects larger than 5GiB, use Scope Download (Node.js SDK) Function.
- Redirecting back to the source can support up to 300GiB.
Sample code
The following code sets the mirroring back-to-source rule 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, RedirectType } 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 {
const mirrorRule = {
// Rule ID
ID: 'rule1',
Condition: {
// The error code that triggers the origin-pull rule currently only supports 404.
HttpCode: 404,
},
Redirect: {
// Redirect rule type
RedirectType: RedirectType.Mirror,
// Whether to fetch data from the configured origin server after redirection
FetchSourceOnRedirect: true,
// Whether to include request parameters when performing redirection
PassQuery: true,
// When the mirror source result is 3XX, whether to redirect to Location to fetch data
FollowRedirect: true,
MirrorHeader: {
// Whether to pass all HTTP headers to the origin server
PassAll: false,
// Pass specified headers to the origin server
Pass: ['header-1', 'header-2'],
// Disable passing specified headers to the origin server
Remove: ['header-3', 'header-4'],
},
// Publicly accessible source address.
PublicSource: {
SourceEndpoint: {
Primary: ['https://www.example.com'],
},
},
},
};
const { requestId: putMirrorBackRequestId } = await client.putBucketMirrorBack({
bucket: bucketName,
rules: [mirrorRule],
});
console.log('putBucketMirrorBack Request ID: ', putMirrorBackRequestId);
} catch (error) {
handleError(error);
}
}
main();
Get mirror back to source
warning
You must be the owner of the bucket in order to obtain the bucket's mirroring back-to-source rule.
Sample code
The following code is used to obtain the mirror back-to-source rule 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 {
const { data, requestId: getMirrorBackRequestId } = await client.getBucketMirrorBack({
bucket: bucketName,
});
console.log('getBucketMirrorBack Request ID: ', getMirrorBackRequestId);
console.log('getBucketMirrorBack Rules Length: ', data.Rules.length);
for (const rule of data.Rules) {
// View rule ID
console.log('rule ID:', rule.ID);
// View the error code that triggers the origin-pull rule, currently only supports 404
console.log('rule Condition HttpCode:', rule.Condition.HttpCode);
// View the redirect type of the origin-pull rule
console.log('rule Redirect RedirectType:', rule.Redirect.RedirectType);
// Whether to fetch data from the origin server after redirection
console.log('rule Redirect FetchSourceOnRedirect:', rule.Redirect.FetchSourceOnRedirect);
// Whether to carry request parameters when performing redirection
console.log('rule Redirect PassQuery:', rule.Redirect.PassQuery);
// When the mirror origin result is 3XX, whether to redirect to Location to obtain data
console.log('rule Redirect FollowRedirect:', rule.Redirect.FollowRedirect);
// Whether to pass all HTTP headers to the origin server
console.log('rule Redirect MirrorHeader PassAll:', rule.Redirect.MirrorHeader.PassAll);
// Pass specified headers to the origin server
console.log('rule Redirect MirrorHeader Pass:', rule.Redirect.MirrorHeader.Pass);
// Prohibit passing specified headers to the origin server
console.log('rule Redirect MirrorHeader Remove:', rule.Redirect.MirrorHeader.Remove);
// Publicly accessible origin server address
console.log('rule Redirect PublicSource SourceEndpoint:', rule.Redirect.PublicSource.SourceEndpoint);
}
} catch (error) {
handleError(error);
}
}
main();
Delete mirror return to source
warning
You must be the owner of the bucket in order to remove the bucket's mirroring back-to-source rule.
Sample code
The following code deletes the mirror return rule 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 {
const { requestId: deleteMirrorBackRequestId } = await client.deleteBucketMirrorBack({
bucket: bucketName,
});
console.log('deleteBucketMirrorBack Request ID: ', deleteMirrorBackRequestId);
} catch (error) {
handleError(error);
}
}
main();
Related documentation
Last updated: 2025.09.22 18:35:45
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
