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 ReferenceBrowser.jsInstalling the Browser.js SDK
Copy page
Download PDFBrowser.js
Installing the Browser.js SDK
Copy pageDownload PDFInstalling the Browser.js SDK
This article outlines the preparatory steps and installation procedures for the Browser.js SDK.
Preparatory Work
- Access via STS: Since the AccessKey of a Volcano Engine account grants permissions to all APIs, if you deploy on the client side, it is recommended to use STS for temporary access to TOS. For more information, please refer to Using STS Temporary AK/SK+Token to Access Volcano Engine TOS.
- Configure Cross-Origin Resource Sharing (CORS): For detailed instructions, please refer to Cross-Origin Access Settings.
- When accessing TOS directly via a browser, the CORS configuration rules are required as follows:
- ParameterDescriptionParameterDescriptionOriginSet a precise domain name (for example, https://console.volcengine.com) or a wildcard asterisk (*).Operation methodsPlease select different Methods according to the actual usage scenario. For example, set to PUT when performing multipart uploads; set to DELETE when deleting files.Allow-HeadersSet to* Expose-HeadersSet to ETag, x-tos-request-id, and x-tos-version-id.
-
SDK Download Link
Supported Browsers
The following browsers are supported by the TOS Browser.js SDK:
- Internet Explorer version 10 and above
- Edge
- Mainstream versions of Chrome, Firefox, and Safari
- Default browsers of mainstream versions of the Android, iOS, and Windows Phone operating systems
Notes
Due to the specific constraints of the browser environment, the TOS Browser.js SDK cannot utilize the following features:
- Operating Local Files: Browsers cannot directly access the local file system. It is recommended to use pre-signed URLs to download files.
- Since TOS temporarily does not support cross-origin requests related to Buckets, it is recommended that you perform Bucket-related operations in the TOS Console.
Install the SDK
Browser Introduction
warning
- As some browsers do not support Promise, you need to include a Promise compatibility library during installation. For example, IE10 and IE11 require the inclusion of promise-polyfill.
- The method of incorporating online resources relies on the stability of CDN servers. Therefore, it is recommended to adopt offline integration, either by utilizing local resources or by building the resources independently.
- Introduction of Online Resources
- <script src="https://tos-public.volccdn.com/obj/volc-tos-public/@volcengine/tos-sdk@latest/browser/tos.umd.production.min.js"></script>
- Incorporating local resources
- <script src="./tos.umd.production.min.js"></script>
Utilize the TOS object in the code.
<script type="text/javascript">
const client = new TOS({
accessKeyId: 'Your Access Key',
accessKeySecret: 'Your Secret Key',
stsToken: 'Your Session Token',
region: 'Your Region',
bucket: 'Your Bucket',
});
</script>
Installing the SDK via npm or yarn
- Install using npm
- npm i @volcengine/tos-sdk
- Install using yarn
- yarn add @volcengine/tos-sdk
After successful installation, you can use import or require to import. You can use the following commands to import the SDK. Note that there are differences between importing modules using ES6 import statements and CommonJS (CJS) import commands.
warning
When using import or require, you need to use relevant bundling tools in the development environment, such as webpack, browserify, etc.
- Use import to perform an import
- import TOS from '@volcengine/tos-sdk';
- Use require to import
- const { TOS } = require('@volcengine/tos-sdk');
Use the TOS object in the code.
<script type="text/javascript">
const client = new TOS({
accessKeyId: 'Your Access Key',
accessKeySecret: 'Your Secret Key',
stsToken: 'Your Session Token',
region: 'Your Region',
bucket: 'Your Bucket',
});
</script>
Last updated: 2025.09.22 18:55:46
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
