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 ReferencePHPInitialize Client (PHP SDK)
Copy page
Download PDFPHP
Initialize Client (PHP SDK)
Copy pageDownload PDFInitialize Client (PHP SDK)
TosClient is the PHP client for TOS, providing a suite of interfaces for interacting with TOS services to manage resources such as buckets and objects.
Prerequisites
Configuring long-term access credentials
Before initializing the SDK, you need to first configure long-term access credentials. This section describes the procedures for configuring long-term access credentials on different operating systems.
macOS
Linux
Windows
- Open the terminal and execute the following command to open the file.
nano ~/.bash_profile
- Add AKSK information at the end of the document.
export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****
- Save the file and exit.
- Execute the following command to make the configuration information take effect.
source ~/.bash_profile
- Execute the following command to verify the configuration information.
echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY
If the configuration is successful, the following example will be returned:
AKTPYmI1Z****
T1dJM01UU****
- Open the terminal and execute the following command to open the file.
sudo vim /etc/profile
- Add AKSK information at the end of the document.
export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****
- Save the file and exit.
- Execute the following commands to make the configuration information take effect.
source /etc/profile
- Execute the following command to verify the configuration information.
echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY
If the configuration is successful, the following example will be returned:
AKTPYmI1Z****
T1dJM01UU****
- Open the command-line tool, execute the following command, and add the AKSK information.
set TOS_ACCESS_KEY=AKTPYmI1Z****
set TOS_SECRET_KEY=T1dJM01UU****
- Execute the following command to apply the configuration settings.
setx TOS_ACCESS_KEY "%TOS_ACCESS_KEY%"
setx TOS_SECRET_KEY "%TOS_SECRET_KEY%"
- Restart the command-line tool, and then execute the following command to verify the configuration information.
echo %TOS_ACCESS_KEY%
echo %TOS_SECRET_KEY%
If the configuration is successful, the following example will be returned:
AKTPYmI1Z****
T1dJM01UU****
Create TosClient
- Using region and endpoint
tip
- Endpoint is the access domain name for TOS external services. For information on Endpoints supported by TOS, please refer to Regions and endpoints.
- AKSK information can be obtained from environment variables. For the configuration method, please refer to Access credential configuration.
<?php
require_once __DIR__ . '/vendor/autoload.php';
use Tos\TosClient;
$region = 'your region';
$endpoint = 'your endpoint';
$ak = getenv('TOS_ACCESS_KEY');
$sk = getenv('TOS_SECRET_KEY');
try {
$client = new TosClient([
'region' => $region,
'endpoint' => $endpoint,
'ak' => $ak,
'sk' => $sk,
]);
} catch (\RuntimeException $ex) {
echo 'create TosClient failed, message: ' . $ex->getMessage() . PHP_EOL;
}
- Using STS
<?php
require_once __DIR__ . '/vendor/autoload.php';
use Tos\TosClient;
$region = 'your region';
$endpoint = 'your endpoint';
$ak = 'your access key';
$sk = 'your secret key';
$securityToken = 'your security token';
try {
$client = new TosClient([
'region' => $region,
'endpoint' => $endpoint,
'ak' => $ak,
'sk' => $sk,
'securityToken' => $securityToken
]);
} catch (\RuntimeException $ex) {
echo 'create TosClient failed, message: ' . $ex->getMessage() . PHP_EOL;
}
Configuration initialization parameters
You can configure TosClient during its creation by specifying initialization parameters. For the parameters that can be configured, please refer to the table below.
Parameter | Type | Required | Example value | Description |
Parameter | Type | Required | Example value | Description |
region | String | Yes | cn-beijing | Region where the TOS server is located. |
endpoint | String | Optional; when left empty, the value is determined by the region parameter. | https://tos-cn-beijing.volces.com/ | TOS server domain name: If no protocol is specified, HTTPS is used by default. The complete format is: https://{host}:{port}. |
ak | String | Mandatory for standard buckets; optional if the bucket allows anonymous access. | AKTPYmI1ZGQwMDA0NjlhNGFkMzhjNzM0N2Q0OTQ3ZTV**** | The Access Key ID in the access key. |
sk | String | Mandatory for standard buckets; optional if the bucket allows anonymous access. | T1dJM01UUXpOak0wTVdWak5EUmtOR0poWldJNU1HWmxaV1V5TkdReVl6**** | The Secret Access Key in the access key. |
securityToken | String | No | 3ZDA5MjY4NWYwMDQyYThlIiwiU2Vzc2lvbk5hbWUiOiJ0b3Nfcm9sZV9z************ | Temporarily authorized Security Token Service (STS). |
connectionTimeout | float | No | 30000 | Connection establishment timeout, unit: milliseconds; default value: 10,000 milliseconds. |
socketTimeout | float | No | 60000 | Socket read/write timeout period, unit: milliseconds; default is 30,000 milliseconds. |
enableVerifySSL | bool | No | true | Whether to enable SSL certificate verification; the default value is true. |
autoRecognizeContentType | bool | No | true | Whether MIME type detection is performed automatically; the default value is true. |
isCustomDomain | bool | No | true | Indicates whether the bucket name is prefixed to the Endpoint to access TOS via a virtual host domain name. The value descriptions are as follows:
The default value is false. tip When accessing TOS via a custom domain, you must set isCustomDomain to true. |
Last updated: 2026.08.03 10:33:39
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
