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 ReferenceJavaObject InterfaceManage ObjectManaging Object Read and Write Permissions (Java SDK)
Copy page
Download PDFManage Object
Managing Object Read and Write Permissions (Java SDK)
Copy pageDownload PDFManaging Object Read and Write Permissions (Java SDK)
This article describes how to obtain and configure access permissions for objects. Object access permissions take precedence over bucket access permissions. If no access permissions are set for the object, the bucket's access permissions will apply.
Configuring object read and write permissions
You can set the read and write permissions for a specified object using the putObjectAcl interface of the TOS Java SDK.
warning
To set read and write permissions for an object, your account must have the tos:PutObjectAcl permission. For specific instructions, please refer to the Permission configuration guide.
Object ACL overview
Object ACL permissions include the following types.
Access permission | Description | Access permission value |
Access permission | Description | Access permission value |
READ | Authorized users are permitted to read object data and its metadata. | PermissionType.PERMISSION_READ |
READ_ACP | Allow authorized users to read the object's ACL. | PermissionType.PERMISSION_READ_ACP |
WRITE_ACP | Allow authorized entities to write to the object ACL. | PermissionType.PERMISSION_WRITE_ACP |
FULL_CONTROL | Authorized users are permitted READ, READ_ACP, and WRITE_ACP permissions on the object. | PermissionType.PERMISSION_FULL_CONTROL |
You may refer to the following code to specify detailed Access Control List (ACL) permissions either in the request body or by setting ACL permissions in the request header.
Provide detailed ACL permission information in the request body
The following code demonstrates how to set object permission information in the request body.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.common.CannedType;
import com.volcengine.tos.comm.common.GranteeType;
import com.volcengine.tos.comm.common.PermissionType;
import com.volcengine.tos.model.acl.GrantV2;
import com.volcengine.tos.model.acl.GranteeV2;
import com.volcengine.tos.model.acl.Owner;
import com.volcengine.tos.model.object.ObjectAclRulesV2;
import com.volcengine.tos.model.object.PutObjectACLInput;
import com.volcengine.tos.model.object.PutObjectACLOutput;
import java.util.ArrayList;
import java.util.List;
public class PutObjectAclWithGrantsExample {
public static void main(String[] args) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
String bucketName = "bucket-example";
String objectKey = "example_dir/example_object.txt";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
String accountId = "the granted account id";
String accountDisplayName = "the granted account display name";
GranteeV2 grantee1 = new GranteeV2().setType(GranteeType.GRANTEE_USER)
.setId(accountId).setDisplayName(accountDisplayName);
GrantV2 grant1 = new GrantV2().setGrantee(grantee1).setPermission(PermissionType.PERMISSION_FULL_CONTROL);
GranteeV2 grantee2 = new GranteeV2().setType(GranteeType.GRANTEE_GROUP)
.setCanned(CannedType.CANNED_ALL_USERS);
GrantV2 grant2 = new GrantV2().setGrantee(grantee2).setPermission(PermissionType.PERMISSION_READ);
List<GrantV2> grantList = new ArrayList<>();
grantList.add(grant1);
grantList.add(grant2);
String ownerId = "your owner id";
String ownerDisplayName = "your owner display name";
Owner owner = new Owner().setId(ownerId).setDisplayName(ownerDisplayName);
PutObjectACLInput input = new PutObjectACLInput().setBucket(bucketName).setKey(objectKey)
.setObjectAclRules(new ObjectAclRulesV2().setGrants(grantList).setOwner(owner));
PutObjectACLOutput output = tos.putObjectAcl(input);
System.out.println("putObjectAcl succeed.");
} catch (TosClientException e) {
System.out.println("putObjectAcl failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("putObjectAcl failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
System.out.println("putObjectAcl failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Configure access permissions in the request header
There are six categories of object read/write permissions that can be configured via the x-tos-acl header.
Access permission | Description | Access permission value |
Access permission | Description | Access permission value |
Private | Private. The owner of the object possesses full permissions, while other users are not authorized to operate the object. | ACLType.ACL_PRIVATE |
Public Read | Public reading. The owner of an object possesses all permissions, while other users have only read permission for that object. | ACLType.ACL_PUBLIC_READ |
Public Read and Write | Public Read/Write All users have read and write permissions for this object. | ACLType.ACL_PUBLIC_READ_WRITE |
Authenticated User Read Access | The owner of the object possesses all permissions, while authenticated users are granted read permission for the object. | ACLType.ACL_AUTHENTICATED_READ |
Bucket Owner Read | The owner of the object has full permissions, while the owner of the bucket has read permission for this object. | ACLType.ACL_BUCKET_OWNER_READ |
Bucket Owner Full Control | Both the bucket owner and the object owner have full operation permissions on the object. | ACLType.ACL_BUCKET_OWNER_FULL_CONTROL |
The following code demonstrates how to set object read and write permissions using x-tos-acl.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.common.ACLType;
import com.volcengine.tos.model.object.PutObjectACLInput;
import com.volcengine.tos.model.object.PutObjectACLOutput;
public class PutObjectAclWithAclHeaderExample {
public static void main(String[] args) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
String bucketName = "bucket-example";
String objectKey = "example_dir/example_object.txt";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
PutObjectACLInput input = new PutObjectACLInput().setAcl(ACLType.ACL_PUBLIC_READ)
.setBucket(bucketName).setKey(objectKey);
PutObjectACLOutput output = tos.putObjectAcl(input);
System.out.println("putObjectAcl succeed.");
} catch (TosClientException e) {
System.out.println("putObjectAcl failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("putObjectAcl failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
System.out.println("putObjectAcl failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
The following code demonstrates how to set object read and write permissions using the x-tos-grant-* header.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.object.PutObjectACLInput;
import com.volcengine.tos.model.object.PutObjectACLOutput;
public class PutObjectAclWithGrantHeaderExample {
public static void main(String[] args) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
String bucketName = "bucket-example";
String objectKey = "example_dir/example_object.txt";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
String grantFullControlRule = "id=\"1000000001\"";
String grantReadRule = "canned=\"AllUsers\"";
PutObjectACLInput input = new PutObjectACLInput().setBucket(bucketName).setKey(objectKey)
.setGrantFullControl(grantFullControlRule).setGrantRead(grantReadRule);
PutObjectACLOutput output = tos.putObjectAcl(input);
System.out.println("putObjectAcl succeed.");
} catch (TosClientException e) {
System.out.println("putObjectAcl failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("putObjectAcl failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
System.out.println("putObjectAcl failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Related documentation
Obtaining access permissions for objects
You can obtain the current read and write permissions configured for a specified object through the TOS Java SDK's getObjectAcl interface.
warning
To obtain access permissions for an object, your account must have the tos:GetObjectACL permission. For specific instructions, please refer to the Permission configuration guide.
The following code demonstrates how to obtain access permissions for an object.
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.acl.GrantV2;
import com.volcengine.tos.model.object.GetObjectACLV2Input;
import com.volcengine.tos.model.object.GetObjectACLV2Output;
public class GetObjectAclExample {
public static void main(String[] args) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
String bucketName = "bucket-example";
String objectKey = "example_dir/example_object.txt";
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try{
GetObjectACLV2Input input = new GetObjectACLV2Input().setBucket(bucketName).setKey(objectKey);
GetObjectACLV2Output output = tos.getObjectAcl(input);
System.out.println("getObjectAcl succeed.");
System.out.println("object owner is " + output.getOwner());
if (output.getGrants() != null && output.getGrants().size() > 0) {
for (GrantV2 grant : output.getGrants()) {
System.out.println("object grant is " + grant);
}
}
} catch (TosClientException e) {
System.out.println("getObjectAcl failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
System.out.println("getObjectAcl failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
System.out.println("getObjectAcl failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Related documentation
Last updated: 2026.07.31 18:30:32
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
