Help Center> Object Storage Service> SDK Reference> Node.js> Bucket Management> Storage Class
View PDF

Storage Class

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference

OBS allows you to set storage classes for buckets. The storage class of an object defaults to be that of its residing bucket. There are three types of storage class for buckets, as described in the following table, catering to various storage performance and cost requirements.

Type

Description

Value in OBS Node.js SDK

OBS Standard

Features low access latency and high throughput and is applicable to storing frequently-accessed (multiple times per month) hotspot or small objects (< 1 MB) requiring quick response.

ObsClient.enums.StorageClassStandard

OBS Infrequent Access

Is applicable to storing semi-frequently accessed (less than 12 times a year) data requiring quick response.

ObsClient.enums.StorageClassWarm

OBS Archive

Is applicable to archiving rarely-accessed (once a year) data.

ObsClient.enums.StorageClassCold

For more information, see Bucket Storage Classes.

Setting the Storage Class for a Bucket

You can call ObsClient.setBucketStoragePolicy to set the storage class for a bucket. Sample code is as follows:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    access_key_id: '*** Provide your Access Key ***',       
    secret_access_key: '*** Provide your Secret Key ***',       
    server : 'https://your-endpoint'
});

obsClient.setBucketStoragePolicy({
       Bucket : 'bucketname',
       StorageClass: obsClient.enums.StorageClassWarm
}, (err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
       }
});

Use the StorageClass parameter to set the storage class for a bucket.

Obtaining the Storage Class of a Bucket

You can call ObsClient.getBucketStoragePolicy to obtain the storage class of a bucket. Sample code is as follows:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    access_key_id: '*** Provide your Access Key ***',       
    secret_access_key: '*** Provide your Secret Key ***',       
    server : 'https://your-endpoint'
});

obsClient.getBucketStoragePolicy({
       Bucket : 'bucketname'
}, (err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                     console.log('StorageClass-->' + result.InterfaceResult.StorageClass);
              }
       }
});
Parent topic: Bucket Management