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 Reference.NETObject InterfaceManage ObjectsManage Object Metadata (.NET SDK)
Copy page
Download PDFManage Objects
Manage Object Metadata (.NET SDK)
Copy pageDownload PDFManage Object Metadata (.NET SDK)
Object metadata refers to the attribute descriptions of an object, encompassing both HTTP standard attributes (HTTP Header) and user-defined metadata (User Meta).
Notes
- Only the object owner has permission to set object metadata.
- When setting user-defined metadata, the user-defined metadata key in English letters supports only lowercase letters and does not allow spaces or other special characters.
Parameters
The TOS .NET SDK enables users to add and modify metadata for objects that have already been uploaded. TOS supports the use of the following six request headers to modify object metadata. When downloading an object or performing a HEAD request, these values are set in the HTTP header fields and returned to the client. The request headers are as follows:
| Description |
| Description |
Content-Type | Object content type, |
Cache-Control | Specifies the caching behavior when the object is downloaded. |
Expires | Specifies the cache expiration time as defined in RFC 2616. |
Content-Disposition | Specifies the default filename of the object when downloaded. |
Content-Encoding | Specifies the content encoding of the object when downloaded. |
Content-Language | Specifies the content language of the object when downloaded. |
x-tos-meta-* | Metadata information set when setting the Meta field using the SDK. When this object is queried, metadata will be included in the Header of the returned message. |
Sample Code
Specifying metadata information during standard upload
The following code is used to set metadata, including cache policy and cache expiration time, during file upload.
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using TOS;
using TOS.Error;
using TOS.Model;
namespace ConsoleApp
{
internal class Program
{
private static void Main(string[] args)
{
var ak = Environment.GetEnvironmentVariable("TOS_ACCESS_KEY");
var sk = Environment.GetEnvironmentVariable("TOS_SECRET_KEY");
var endpoint = "https://tos-cn-beijing.volces.com";
var region = "cn-beijing";
var bucketName = "*** Provide your bucket name ***";
var objectContent = "Hello TOS";
var objectKey = "example_dir/example.txt";
var client = TosClientBuilder.Builder().SetAk(ak).SetSk(sk).SetEndpoint(endpoint).SetRegion(region).Build();
try
{
byte[] binaryData = Encoding.UTF8.GetBytes(objectContent);
using (MemoryStream requestContent = new MemoryStream(binaryData))
{
var putObjectInput = new PutObjectInput()
{
Bucket = bucketName,
Key = objectKey,
Meta = new Dictionary<string, string>() { { "key", "value" } },
ContentType = "text/html",
ContentLanguage = "zh-cn",
CacheControl = "no-store",
Expires = DateTime.Now.AddHours(1),
ContentDisposition = "example.png",
ContentEncoding = "deflate",
Content = requestContent
};
var putObjectOutput = client.PutObject(putObjectInput);
Console.WriteLine("Put object succeeded, ETag: {0} ", putObjectOutput.ETag);
}
}
catch (TosServerException ex)
{
Console.WriteLine("Put object failed, request id {0}", ex.RequestID);
Console.WriteLine("Put object failed, status code {0}", ex.StatusCode);
Console.WriteLine("Put object failed, response error code {0}", ex.Code);
Console.WriteLine("Put object failed, response error message {0}", ex.Message);
}
catch (TosClientException ex)
{
Console.WriteLine("Put object failed, error message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("Put object failed, {0}", ex.Message);
}
}
}
}
Configuring metadata during multipart upload
The following code is used to set metadata information, such as cache policy and cache expiration time, during multipart upload.
using System;
using System.Collections.Generic;
using System.IO;
using TOS;
using TOS.Error;
using TOS.Model;
namespace ConsoleApp
{
internal class Program
{
private static void Main(string[] args)
{
var ak = Environment.GetEnvironmentVariable("TOS_ACCESS_KEY");
var sk = Environment.GetEnvironmentVariable("TOS_SECRET_KEY");
var endpoint = "https://tos-cn-beijing.volces.com";
var region = "cn-beijing";
var bucketName = "*** Provide your bucket name ***";
var objectKey = "example_dir/example.txt";
var localFileName = "/usr/local/test.txt";
var client = TosClientBuilder.Builder().SetAk(ak).SetSk(sk).SetEndpoint(endpoint).SetRegion(region).Build();
var uploadID = "";
try
{
var createMultipartUploadInput = new CreateMultipartUploadInput()
{
Bucket = bucketName,
Key = objectKey,
Meta = new Dictionary<string, string>() { { "key", "value" } },
ContentType = "text/html",
ContentLanguage = "zh-cn",
CacheControl = "no-store",
Expires = DateTime.Now.AddHours(1),
ContentDisposition = "example.png",
ContentEncoding = "deflate",
};
var createMultipartUploadOutput = client.CreateMultipartUpload(createMultipartUploadInput);
uploadID = createMultipartUploadOutput.UploadID;
Console.WriteLine("CreateMultipartUpload succeeded, request id {0}",
createMultipartUploadOutput.RequestID);
Console.WriteLine("CreateMultipartUpload succeeded, upload id {0}", uploadID);
}
catch (TosServerException ex)
{
Console.WriteLine("CreateMultipartUpload failed, request id {0}", ex.RequestID);
Console.WriteLine("CreateMultipartUpload failed, status code {0}", ex.StatusCode);
Console.WriteLine("CreateMultipartUpload failed, response error code {0}", ex.Code);
Console.WriteLine("CreateMultipartUpload failed, response error message {0}", ex.Message);
}
catch (TosClientException ex)
{
Console.WriteLine("CreateMultipartUpload failed, error message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("CreateMultipartUpload failed, {0}", ex.Message);
}
Int64 partSize = 20 * 1024 * 1024;
var fi = new FileInfo(localFileName);
var fileSize = fi.Length;
var partCount = fileSize / partSize;
if (fileSize % partSize != 0)
{
partCount++;
}
var parts = new UploadedPart[partCount];
try
{
using (var fileStream = File.Open(localFileName, FileMode.Open, FileAccess.Read))
{
for (var i = 0; i < partCount; i++)
{
var offset = partSize * i;
fileStream.Seek(offset, 0);
var contentSize = (partSize < fileSize - offset) ? partSize : (fileSize - offset);
var UploadPartInput = new UploadPartInput()
{
Bucket = bucketName,
Key = objectKey,
UploadID = uploadID,
PartNumber = i + 1,
Content = fileStream,
ContentLength = contentSize
};
var uploadPartOutput = client.UploadPart(UploadPartInput);
parts[i] = new UploadedPart { PartNumber = i + 1, ETag = uploadPartOutput.ETag };
Console.WriteLine("UploadPart succeeded, request id {0}", uploadPartOutput.RequestID);
}
}
}
catch (TosServerException ex)
{
Console.WriteLine("UploadPart failed, request id {0}", ex.RequestID);
Console.WriteLine("UploadPart failed, status code {0}", ex.StatusCode);
Console.WriteLine("UploadPart failed, response error code {0}", ex.Code);
Console.WriteLine("UploadPart failed, response error message {0}", ex.Message);
}
catch (TosClientException ex)
{
Console.WriteLine("UploadPart failed, error message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("UploadPart failed, {0}", ex.Message);
}
try
{
var completeMultipartUploadInput = new CompleteMultipartUploadInput()
{
Bucket = bucketName,
Key = objectKey,
UploadID = uploadID,
Parts = parts
};
var completeMultipartUploadOutput = client.CompleteMultipartUpload(completeMultipartUploadInput);
Console.WriteLine("CompleteMultipartUpload succeeded, request id {0}",
completeMultipartUploadOutput.RequestID);
}
catch (TosServerException ex)
{
Console.WriteLine("CompleteMultipartUpload failed, request id {0}", ex.RequestID);
Console.WriteLine("CompleteMultipartUpload failed, status code {0}", ex.StatusCode);
Console.WriteLine("CompleteMultipartUpload failed, response error code {0}", ex.Code);
Console.WriteLine("CompleteMultipartUpload failed, response error message {0}", ex.Message);
}
catch (TosClientException ex)
{
Console.WriteLine("CompleteMultipartUpload failed, error message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("CompleteMultipartUpload failed, {0}", ex.Message);
}
}
}
}
Set object metadata information using SetObjectMeta.
The following code is used to update object metadata, such as caching policy and cache expiration time, via the SetObjectMeta interface.
using System;
using System.Collections.Generic;
using TOS;
using TOS.Error;
using TOS.Model;
namespace ConsoleApp
{
internal class Program
{
private static void Main(string[] args)
{
var ak = Environment.GetEnvironmentVariable("TOS_ACCESS_KEY");
var sk = Environment.GetEnvironmentVariable("TOS_SECRET_KEY");
var endpoint = "https://tos-cn-beijing.volces.com";
var region = "cn-beijing";
var bucketName = "*** Provide your bucket name ***";
var objectKey = "*** Provide your object key ***";
var client = TosClientBuilder.Builder().SetAk(ak).SetSk(sk).SetEndpoint(endpoint).SetRegion(region).Build();
try
{
var setObjectMetaInput = new SetObjectMetaInput()
{
Bucket = bucketName,
Key = objectKey,
Meta = new Dictionary<string, string>() { { "key", "value" } },
ContentType = "text/html",
ContentLanguage = "zh-cn",
CacheControl = "no-store",
Expires = DateTime.Now.AddHours(1),
ContentDisposition = "example.png",
ContentEncoding = "deflate",
};
var setObjectMetaOutput = client.SetObjectMeta(setObjectMetaInput);
Console.WriteLine("Set object meta succeeded, request id: {0} ", setObjectMetaOutput.RequestID);
}
catch (TosServerException ex)
{
Console.WriteLine("Set object meta failed, request id {0}", ex.RequestID);
Console.WriteLine("Set object meta failed, status code {0}", ex.StatusCode);
Console.WriteLine("Set object meta failed, response error code {0}", ex.Code);
Console.WriteLine("Set object meta failed, response error message {0}", ex.Message);
}
catch (TosClientException ex)
{
Console.WriteLine("Set object meta failed, error message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("Set object meta failed, {0}", ex.Message);
}
}
}
}
Query Object Metadata Information (Determine Whether the Object Exists)
warning
Before retrieving object metadata, you must ensure that your account has the tos:GetObject permission. For specific steps, please refer to IAM Policy Overview.
The following code is used to query object metadata and determine whether the object exists. If the object does not exist, an error message will be returned.
using System;
using TOS;
using TOS.Error;
using TOS.Model;
namespace ConsoleApp
{
internal class Program
{
private static void Main(string[] args)
{
var ak = Environment.GetEnvironmentVariable("TOS_ACCESS_KEY");
var sk = Environment.GetEnvironmentVariable("TOS_SECRET_KEY");
var endpoint = "https://tos-cn-beijing.volces.com";
var region = "cn-beijing";
var bucketName = "*** Provide your bucket name ***";
var objectKey = "*** Provide your object key ***";
var client = TosClientBuilder.Builder().SetAk(ak).SetSk(sk).SetEndpoint(endpoint).SetRegion(region).Build();
try
{
var headObjectInput = new HeadObjectInput()
{
Bucket = bucketName,
Key = objectKey,
};
var headObjectOutput = client.HeadObject(headObjectInput);
Console.WriteLine("HeadObject succeeded, Request ID: {0} ", headObjectOutput.RequestID);
Console.WriteLine("HeadObject succeeded, Response ContentLanguage: {0} ",
headObjectOutput.ContentLanguage);
Console.WriteLine("HeadObject succeeded, Response ContentDisposition: {0} ",
headObjectOutput.ContentDisposition);
Console.WriteLine("HeadObject succeeded, Response ContentEncoding: {0} ",
headObjectOutput.ContentEncoding);
Console.WriteLine("HeadObject succeeded, Response CacheControl: {0} ", headObjectOutput.CacheControl);
Console.WriteLine("HeadObject succeeded, Response ContentType: {0} ", headObjectOutput.ContentType);
Console.WriteLine("HeadObject succeeded, Response Expires: {0} ", headObjectOutput.Expires);
}
catch (TosServerException ex)
{
if (ex.StatusCode == 404)
{
Console.WriteLine("Object not found");
}
else
{
Console.WriteLine("HeadObject failed, Request ID {0}", ex.RequestID);
Console.WriteLine("HeadObject failed, Status Code {0}", ex.StatusCode);
Console.WriteLine("HeadObject failed, Response Error Code {0}", ex.Code);
Console.WriteLine("HeadObject failed, Response Error Message {0}", ex.Message);
}
}
catch (TosClientException ex)
{
Console.WriteLine("HeadObject failed, Error Message {0}", ex.Message);
}
catch (Exception ex)
{
Console.WriteLine("HeadObject failed, {0}", ex.Message);
}
}
}
}
Related documentation
Last updated: 2025.09.23 11:28:05
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
