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 ReferenceRustBucket interfaceCustom domainPutBucketCustomDomain（Rust SDK）
Copy page
Download PDFCustom domain
PutBucketCustomDomain（Rust SDK）
Copy pageDownload PDFPutBucketCustomDomain（Rust SDK）
The put_bucket_custom_domain interface binds a custom domain name to a bucket. This article explains how to bind it using the put_bucket_custom_domain interface in the Rust SDK. After binding, you must point the domain's CNAME to the bucket's external network domain name.
Notes
- You need to fill in the region and access domain in the sample code according to your actual situation. For details, see Region and Access Domain.
- To prevent key leakage, the sample code reads the Access Key ID and Secret Access Key from environment variables. Therefore, before using the SDK, configure long-term access credentials. For details, see Configure Long-term Access Credentials.
- Each bucket can hold up to 20 bound custom domain names. If exceeded, put_bucket_custom_domain returns an error.
- The domain field in the request body must be a domain name that has passed ICP filing; otherwise, put_bucket_custom_domain will not take effect.
- If cert_id is empty, put_bucket_custom_domain uses the HTTP protocol; if cert_id is provided, the system enforces HTTPS and verifies the certificate's validity.
Permissions required
The Volcano Engine main account has all permissions by default, but IAM users have no permissions by default. If you need to use a sub-account to perform the put_bucket_custom_domain operation, the Volcano Engine main account must grant the following permissions to the sub-account through IAM policies and bucket policies:
tos:PutBucketCustomDomain
Code example
Bind a custom domain to a bucket
use async_trait::async_trait;
use futures_core::future::BoxFuture;
use std::env;
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Handle;
use ve_tos_rust_sdk::asynchronous::bucket::BucketAPI;
use ve_tos_rust_sdk::asynchronous::tos;
use ve_tos_rust_sdk::asynchronous::tos::AsyncRuntime;
use ve_tos_rust_sdk::bucket::{CustomDomainRule, PutBucketCustomDomainInput};
use ve_tos_rust_sdk::enumeration::AuthProtocolType;
#[derive(Debug, Default)]
pub struct TokioRuntime {}
#[async_trait]
impl AsyncRuntime for TokioRuntime {
type JoinError = tokio::task::JoinError;
async fn sleep(&self, duration: Duration) {
tokio::time::sleep(duration).await;
}
fn spawn<'a, F>(&self, future: F) -> BoxFuture<'a, Result<F::Output, Self::JoinError>>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
Box::pin(Handle::current().spawn(future))
}
fn block_on<F: Future>(&self, future: F) -> F::Output {
Handle::current().block_on(future)
}
}
#[tokio::main]
async fn main() {
let ak = env::var("TOS_ACCESS_KEY").unwrap_or("".to_string());
let sk = env::var("TOS_SECRET_KEY").unwrap_or("".to_string());
let endpoint = "https://tos-cn-beijing.volces.com";
let region = "cn-beijing";
let client = tos::builder::<TokioRuntime>()
.connection_timeout(3000)
.request_timeout(10000)
.max_retry_count(3)
.ak(ak)
.sk(sk)
.region(region)
.endpoint(endpoint)
.build().unwrap();
// Create custom domain rules
let rule = CustomDomainRule::new("example.com", AuthProtocolType::AuthProtocolTos);
// Create input parameters
let input = PutBucketCustomDomainInput::new("my-bucket", rule);
// Call the API and bind a custom domain
let output = client.put_bucket_custom_domain(&input).await;
match output {
Ok(output) => {
println!("Custom domain binding successful，Request ID: {}", output.request_id());
}
Err(err) => {
eprintln!("Custom domain binding failed: {:?}", err);
}
}
}
Set multiple custom domains for a bucket
use async_trait::async_trait;
use futures_core::future::BoxFuture;
use std::env;
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Handle;
use ve_tos_rust_sdk::asynchronous::bucket::BucketAPI;
use ve_tos_rust_sdk::asynchronous::tos;
use ve_tos_rust_sdk::asynchronous::tos::AsyncRuntime;
use ve_tos_rust_sdk::bucket::{CustomDomainRule, PutBucketCustomDomainInput};
use ve_tos_rust_sdk::enumeration::AuthProtocolType;
#[derive(Debug, Default)]
pub struct TokioRuntime {}
#[async_trait]
impl AsyncRuntime for TokioRuntime {
type JoinError = tokio::task::JoinError;
async fn sleep(&self, duration: Duration) {
tokio::time::sleep(duration).await;
}
fn spawn<'a, F>(&self, future: F) -> BoxFuture<'a, Result<F::Output, Self::JoinError>>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
Box::pin(Handle::current().spawn(future))
}
fn block_on<F: Future>(&self, future: F) -> F::Output {
Handle::current().block_on(future)
}
}
#[tokio::main]
async fn main() {
let ak = env::var("TOS_ACCESS_KEY").unwrap_or("".to_string());
let sk = env::var("TOS_SECRET_KEY").unwrap_or("".to_string());
let endpoint = "https://tos-cn-beijing.volces.com";
let region = "cn-beijing";
let client = tos::builder::<TokioRuntime>()
.connection_timeout(3000)
.request_timeout(10000)
.max_retry_count(3)
.ak(ak)
.sk(sk)
.region(region)
.endpoint(endpoint)
.build().unwrap();
// Define multiple domain configurations
let domains = vec![
("domain1.com", AuthProtocolType::AuthProtocolTos, ""),
("domain2.com", AuthProtocolType::AuthProtocolS3, "cert-1234567890"),
("domain3.com", AuthProtocolType::AuthProtocolTos, ""),
];
for (domain, protocol, cert_id) in domains {
// Create custom domain rules
let mut rule = CustomDomainRule::new(domain, protocol);
// If a certificate ID is available, then set it
if !cert_id.is_empty() {
rule.set_cert_id(cert_id);
}
// Create input parameters
let input = PutBucketCustomDomainInput::new("my-bucket", rule);
// Call the API and bind a custom domain
let output = client.put_bucket_custom_domain(&input).await;
match output {
Ok(output) => {
println!("Domain name {} successfully bound, Request ID: {}", domain, output.request_id());
}
Err(err) => {
eprintln!("Domain name {} binding failed: {:?}", domain, err);
}
}
}
}
Set certificate ID for a custom domain
use async_trait::async_trait;
use futures_core::future::BoxFuture;
use std::env;
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Handle;
use ve_tos_rust_sdk::asynchronous::bucket::BucketAPI;
use ve_tos_rust_sdk::asynchronous::tos;
use ve_tos_rust_sdk::asynchronous::tos::AsyncRuntime;
use ve_tos_rust_sdk::bucket::{CustomDomainRule, PutBucketCustomDomainInput};
use ve_tos_rust_sdk::enumeration::AuthProtocolType;
#[derive(Debug, Default)]
pub struct TokioRuntime {}
#[async_trait]
impl AsyncRuntime for TokioRuntime {
type JoinError = tokio::task::JoinError;
async fn sleep(&self, duration: Duration) {
tokio::time::sleep(duration).await;
}
fn spawn<'a, F>(&self, future: F) -> BoxFuture<'a, Result<F::Output, Self::JoinError>>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
Box::pin(Handle::current().spawn(future))
}
fn block_on<F: Future>(&self, future: F) -> F::Output {
Handle::current().block_on(future)
}
}
#[tokio::main]
async fn main() {
let ak = env::var("TOS_ACCESS_KEY").unwrap_or("".to_string());
let sk = env::var("TOS_SECRET_KEY").unwrap_or("".to_string());
let endpoint = "https://tos-cn-beijing.volces.com";
let region = "cn-beijing";
let client = tos::builder::<TokioRuntime>()
.connection_timeout(3000)
.request_timeout(10000)
.max_retry_count(3)
.ak(ak)
.sk(sk)
.region(region)
.endpoint(endpoint)
.build().unwrap();
// Create custom domain rules
let mut rule = CustomDomainRule::new("secure-domain.com", AuthProtocolType::AuthProtocolTos);
// Set Certificate ID
rule.set_cert_id("cert-***");
// Create input parameters
let input = PutBucketCustomDomainInput::new("my-bucket", rule);
// Call the API and bind a custom domain
let output = client.put_bucket_custom_domain(&input).await;
match output {
Ok(output) => {
println!("Custom domain name with certificate successfully bound, request ID: {}", output.request_id());
}
Err(err) => {
eprintln!("Custom domain binding with certificate failed: {:?}", err);
}
}
}
Bind a custom domain using the S3 protocol
use async_trait::async_trait;
use futures_core::future::BoxFuture;
use std::env;
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Handle;
use ve_tos_rust_sdk::asynchronous::bucket::BucketAPI;
use ve_tos_rust_sdk::asynchronous::tos;
use ve_tos_rust_sdk::asynchronous::tos::AsyncRuntime;
use ve_tos_rust_sdk::bucket::{CustomDomainRule, PutBucketCustomDomainInput};
use ve_tos_rust_sdk::enumeration::AuthProtocolType;
#[derive(Debug, Default)]
pub struct TokioRuntime {}
#[async_trait]
impl AsyncRuntime for TokioRuntime {
type JoinError = tokio::task::JoinError;
async fn sleep(&self, duration: Duration) {
tokio::time::sleep(duration).await;
}
fn spawn<'a, F>(&self, future: F) -> BoxFuture<'a, Result<F::Output, Self::JoinError>>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
Box::pin(Handle::current().spawn(future))
}
fn block_on<F: Future>(&self, future: F) -> F::Output {
Handle::current().block_on(future)
}
}
#[tokio::main]
async fn main() {
let ak = env::var("TOS_ACCESS_KEY").unwrap_or("".to_string());
let sk = env::var("TOS_SECRET_KEY").unwrap_or("".to_string());
let endpoint = "https://tos-cn-beijing.volces.com";
let region = "cn-beijing";
let client = tos::builder::<TokioRuntime>()
.connection_timeout(3000)
.request_timeout(10000)
.max_retry_count(3)
.ak(ak)
.sk(sk)
.region(region)
.endpoint(endpoint)
.build().unwrap();
// Create custom domain rules using the S3 protocol
let rule = CustomDomainRule::new("s3-domain.com", AuthProtocolType::AuthProtocolS3);
// Create input parameters
let input = PutBucketCustomDomainInput::new("my-bucket", rule);
// Call the API and bind a custom domain
let output = client.put_bucket_custom_domain(&input).await;
match output {
Ok(output) => {
println!("S3 protocol custom domain binding successful, requesting ID: {}", output.request_id());
}
Err(err) => {
eprintln!("S3 protocol custom domain binding failed: {:?}", err);
}
}
}
Bind a custom domain using the TOS protocol
use async_trait::async_trait;
use futures_core::future::BoxFuture;
use std::env;
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Handle;
use ve_tos_rust_sdk::asynchronous::bucket::BucketAPI;
use ve_tos_rust_sdk::asynchronous::tos;
use ve_tos_rust_sdk::asynchronous::tos::AsyncRuntime;
use ve_tos_rust_sdk::bucket::{CustomDomainRule, PutBucketCustomDomainInput};
use ve_tos_rust_sdk::enumeration::AuthProtocolType;
#[derive(Debug, Default)]
pub struct TokioRuntime {}
#[async_trait]
impl AsyncRuntime for TokioRuntime {
type JoinError = tokio::task::JoinError;
async fn sleep(&self, duration: Duration) {
tokio::time::sleep(duration).await;
}
fn spawn<'a, F>(&self, future: F) -> BoxFuture<'a, Result<F::Output, Self::JoinError>>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
Box::pin(Handle::current().spawn(future))
}
fn block_on<F: Future>(&self, future: F) -> F::Output {
Handle::current().block_on(future)
}
}
#[tokio::main]
async fn main() {
let ak = env::var("TOS_ACCESS_KEY").unwrap_or("".to_string());
let sk = env::var("TOS_SECRET_KEY").unwrap_or("".to_string());
let endpoint = "https://tos-cn-beijing.volces.com";
let region = "cn-beijing";
let client = tos::builder::<TokioRuntime>()
.connection_timeout(3000)
.request_timeout(10000)
.max_retry_count(3)
.ak(ak)
.sk(sk)
.region(region)
.endpoint(endpoint)
.build()
.unwrap();
// Create custom domain rules using the TOS protocol
let rule = CustomDomainRule::new("my-domain.com", AuthProtocolType::AuthProtocolTos);
// Create input parameters
let input = PutBucketCustomDomainInput::new("my-bucket", rule);
// Call the API and bind a custom domain
let output = client.put_bucket_custom_domain(&input).await;
match output {
Ok(output) => {
println!(
"TOS protocol custom domain binding successful, requesting ID: {}",
output.request_id()
);
}
Err(err) => {
eprintln!("TOS protocol custom domain binding failed: {:?}", err);
}
}
}
Related documentation
Last updated: 2026.01.06 18:07:30
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
