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 ReferenceNode.jsObject InterfaceManage objectsManaging Object Access Permissions (Node.js SDK)
Copy page
Download PDFManage objects
Managing Object Access Permissions (Node.js SDK)
Copy pageDownload PDFManaging Object Access Permissions (Node.js SDK)
This article describes how to obtain and set access permissions for objects. The access rights of an object take precedence over the access rights of the bucket, and if the object has no access rights set, the access rights of the bucket are followed.
Set the read and write permissions of the object
warning
You must have tos: PutObjectACLpermission or WRITE_ACP object ACL permission before setting the object read and write permissions, see Overview.
ACL Description
Object ACL permissions include the following types.
access rights | describe | access permission value |
access rights | describe | access permission value |
READ | Allows authorized persons to read object data and its metadata | PermissionType.PermissionRead |
READ_ACP | Allows authorized persons to read the object ACL | PermissionType.PermissionReadAcp |
WRITE_ACP | Allows authorized parties to write ACLs for applicable objects | PermissionType.PermissionWriteAcp |
FULL_CONTROL | Allows authorized READ, READ_ACP, and WRITE_ACP permissions on objects | PermissionType.PermissionFullControl |
You can fill in detailed ACL permission information in the request body, or set access permissions in the request header.
Fill in the detailed ACL permission information in the request body
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { TosClient, TosClientError, TosServerError, GranteeType, PermissionType } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.requestId);
console.log('Response Status Code:', error.statusCode);
console.log('Response Header:', error.headers);
console.log('Response Err Code:', error.code);
console.log('Response Err Msg:', error.message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'node-sdk-test-bucket';
// The specified objectKey.
const objectKey = '*** Provide your object key ***';
// Set object ACL.
const { requestId } = await client.putObjectAcl({
bucket: bucketName,
key: objectKey,
// If versioning is enabled for the bucket, you can specify a particular version by setting the versionId.
versionId: '',
aclBody: {
Owner: {
// Get Bucket Owner ID
ID: 'ownerid',
},
Grants: [
{
Grantee: {
ID: 'userId',
Type: GranteeType.GranteeUser,
},
Permission: PermissionType.PermissionRead,
},
],
},
});
console.log('putObjectAcl Request ID:', requestId);
} catch (error) {
handleError(error);
}
}
main();
Set access permissions in the request header
The read and write permissions of the object set by the x-tos-acl request header include the following types.
access rights | describe | access permission value |
access rights | describe | access permission value |
private | The owner of the object has all permissions, and no other user has permission to operate on the object. | private |
public reading | The owner of the object has all permissions, other users only have read permissions to the object. | public-read |
public reading and writing | All users have read access to the object. | public-read-write |
authenticated user read | The owner of the object has all permissions, and the authenticated user has read access to the object. | authenticated-read |
Bucket owner read | The object owner has all permissions, and the bucket owner has read permissions on this object. | bucket-owner-read |
The bucket owner has all permissions | Both the bucket owner and the object owner have all the operating rights on the object. | bucket-owner-full-control |
The following code sets the read and write permissions of an object via x-tos-acl.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { TosClient, TosClientError, TosServerError, ACLType } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.requestId);
console.log('Response Status Code:', error.statusCode);
console.log('Response Header:', error.headers);
console.log('Response Err Code:', error.code);
console.log('Response Err Msg:', error.message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'node-sdk-test-bucket';
// The specified objectKey.
const objectKey = '*** Provide your object key ***';
// Set object ACL
const { requestId } = await client.putObjectAcl({
bucket: bucketName,
key: objectKey,
// If the bucket has versioning enabled, you can specify a specific version by setting the versionId.
// versionId: '',
acl: ACLType.ACLPublicRead,
});
console.log('putObjectAcl Request ID:', requestId);
} catch (error) {
handleError(error);
}
}
main();
Related documentation
Gets read and write permissions for an object
warning
You must have the tos: GetObjectACLpermission or READ_ACP ACL permission for the object before you can gain access to the object, see Overview.
The following code is used to obtain access to an object.
// Import SDK, if the TOS Node.JS SDK version is less than 2.5.2, please change "TosClient" to "TOS" in the code below.
import { TosClient, TosClientError, TosServerError, ACLType } from '@volcengine/tos-sdk';
// Create a client.
const client = new TosClient({
accessKeyId: process.env['TOS_ACCESS_KEY'],
accessKeySecret: process.env['TOS_SECRET_KEY'],
region: "Provide your region", // Fill in the region where the Bucket is located. For example, if it is in China North 2 (Beijing), fill in "Provide your region" as cn-beijing.
endpoint: "Provide your endpoint", // Enter the domain address.
});
function handleError(error) {
if (error instanceof TosClientError) {
console.log('Client Err Msg:', error.message);
console.log('Client Err Stack:', error.stack);
} else if (error instanceof TosServerError) {
console.log('Request ID:', error.requestId);
console.log('Response Status Code:', error.statusCode);
console.log('Response Header:', error.headers);
console.log('Response Err Code:', error.code);
console.log('Response Err Msg:', error.message);
} else {
console.log('unexpected exception, message: ', error);
}
}
async function main() {
try {
const bucketName = 'node-sdk-test-bucket';
// The specified objectKey
const objectKey = '*** Provide your object key ***';
// Set object ACL
const { data, requestId } = await client.getObjectAcl({
bucket: bucketName,
key: objectKey,
// If versioning is enabled for the bucket, you can specify a particular version by setting the versionId.
// versionId: '',
});
console.log('getObjectAcl Request ID:', requestId);
// Get object Owner information
console.log('GetObjectACL Owner: %o', data.Owner);
for (const grant of data.Grants) {
// Permissions held by the grantee
console.log('Grant Permission:', grant.Permission);
// Type of the grantee
console.log('Grant GranteeV2 Type', grant.Grantee.Type);
// When Type is CanonicalUser, it represents the ID of the grantee
console.log('Grant GranteeV2 ID', grant.Grantee.ID);
// Name of the grantee
console.log('Grant GranteeV2 DisplayName', grant.Grantee.DisplayName);
// Authorized user group
console.log('Grant GranteeV2 Canned', grant.Grantee.Canned);
}
} catch (error) {
handleError(error);
}
}
main();
Related documentation
Last updated: 2025.09.22 18:35:46
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
